com.helger.jcodemodel

Class AbstractCodeWriter

java.lang.Object

com.helger.jcodemodel.AbstractCodeWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FileCodeWriter, FilterCodeWriter, OutputStreamCodeWriter, SingleStreamCodeWriter, ZipCodeWriter

public abstract class AbstractCodeWriter
extends Object
implements Closeable

Receives generated code and writes to the appropriate storage.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCodeWriter(Charset aEncoding)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Called by CodeModel at the end of the process.
Charset	encoding()
abstract OutputStream	openBinary(JPackage pkg, String fileName) Called by CodeModel to store the specified file.
Writer	openSource(JPackage pkg, String fileName) Called by CodeModel to store the specified file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCodeWriter

protected AbstractCodeWriter(@Nullable
                  Charset aEncoding)

Method Detail

encoding

@Nullable
public Charset encoding()

openBinary

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

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.

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

openSource

@Nonnull
public Writer openSource(@Nonnull
                        JPackage pkg,
                        @Nonnull
                        String fileName)
                  throws IOException

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.

Parameters:

pkg - The package of the file to be written.

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

Returns:

Writer to write to

Throws:

IOException - On IO error

close

public abstract void close()
                    throws IOException

Called by CodeModel at the end of the process.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException