com.helger.jcodemodel.writer

Class FileCodeWriter

java.lang.Object

com.helger.jcodemodel.AbstractCodeWriter

com.helger.jcodemodel.writer.FileCodeWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class FileCodeWriter
extends AbstractCodeWriter

Writes all the source files under the specified file folder.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
FileCodeWriter(File aTargetDir)
FileCodeWriter(File aTargetDir, boolean bMarkReadOnly)
FileCodeWriter(File aTargetDir, boolean bMarkReadOnly, Charset encoding)
FileCodeWriter(File aTargetDir, Charset encoding)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Called by CodeModel at the end of the process.
protected File	getFile(JPackage pkg, String fileName)
OutputStream	openBinary(JPackage pkg, String fileName) Called by CodeModel to store the specified file.

Methods inherited from class com.helger.jcodemodel.AbstractCodeWriter

encoding, openSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileCodeWriter

public FileCodeWriter(@Nonnull
              File aTargetDir)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(@Nonnull
              File aTargetDir,
              @Nullable
              Charset encoding)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(@Nonnull
              File aTargetDir,
              boolean bMarkReadOnly)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(@Nonnull
              File aTargetDir,
              boolean bMarkReadOnly,
              @Nullable
              Charset encoding)
               throws IOException

Throws:

IOException

Method Detail

openBinary

@Nonnull
public OutputStream openBinary(@Nonnull
                              JPackage pkg,
                              @Nonnull
                              String fileName)
                        throws IOException

Description copied from class: AbstractCodeWriter

Called by CodeModel to store the specified file. The callee must allocate a storage to store the specified file.
The returned stream will be closed before the next file is stored. So the callee can assume that only one OutputStream is active at any given time.

Specified by:

openBinary in class AbstractCodeWriter

Parameters:

pkg - The package of the file to be written.

fileName - File name without the path. Something like "Foo.java" or "Bar.properties"

Returns:

OutputStream to write to

Throws:

IOException - On IO error

getFile

@Nonnull
protected File getFile(@Nonnull
                   JPackage pkg,
                   @Nonnull
                   String fileName)
                throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: AbstractCodeWriter

Called by CodeModel at the end of the process.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class AbstractCodeWriter

Throws:

IOException