Class FileCodeWriter

java.lang.Object

com.sun.codemodel.CodeWriter

com.sun.codemodel.writer.FileCodeWriter

public class FileCodeWriter
extends CodeWriter

Writes all the source files under the specified file folder.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	readOnly	specify whether or not to mark the generated files read-only
private final Set<File>	readonlyFiles	Files that shall be marked as read only.
private final File	target	The target directory to put source code.

Fields inherited from class CodeWriter

encoding

Constructor Summary

Constructors

Constructor	Description
FileCodeWriter(File target)
FileCodeWriter(File target, boolean readOnly)
FileCodeWriter(File target, boolean readOnly, String encoding)
FileCodeWriter(File target, String encoding)

Method Summary

Modifier and Type	Method	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.
private static String	toDirName(JPackage pkg)	Converts a package name to the directory name.

Methods inherited from class CodeWriter

openSource

Methods inherited from class Object

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

Field Details

target

private final File target

The target directory to put source code.

readOnly

private final boolean readOnly

specify whether or not to mark the generated files read-only

readonlyFiles

private final Set<File> readonlyFiles

Files that shall be marked as read only.

Constructor Details

FileCodeWriter

public FileCodeWriter(File target)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(File target,
 String encoding)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(File target,
 boolean readOnly)
               throws IOException

Throws:

IOException

FileCodeWriter

public FileCodeWriter(File target,
 boolean readOnly,
 String encoding)
               throws IOException

Throws:

IOException

Method Details

openBinary

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

Description copied from class: CodeWriter

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 CodeWriter

Parameters:

pkg - The package of the file to be written.

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

Throws:

IOException

getFile

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

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: CodeWriter

Called by CodeModel at the end of the process.

Specified by:

close in class CodeWriter

Throws:

IOException

toDirName

private static String toDirName(JPackage pkg)

Converts a package name to the directory name.