com.helger.jcodemodel.writer

Class SingleStreamCodeWriter

java.lang.Object

com.helger.jcodemodel.AbstractCodeWriter

com.helger.jcodemodel.writer.SingleStreamCodeWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class SingleStreamCodeWriter
extends AbstractCodeWriter

Output all source files into a single stream with a little formatting header in front of each file. This is primarily for human consumption of the generated source code, such as to debug/test CodeModel or to quickly inspect the result.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
SingleStreamCodeWriter(OutputStream aOS)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Called by CodeModel at the end of the process.
OutputStream	openBinary(JPackage aPkg, String sFilename) 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

SingleStreamCodeWriter

public SingleStreamCodeWriter(@Nonnull
                      OutputStream aOS)

Parameters:

aOS - This stream will be closed at the end of the code generation. Except it is System.out or System.err

Method Detail

openBinary

public OutputStream openBinary(@Nonnull
                      JPackage aPkg,
                      @Nonnull
                      String sFilename)
                        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:

aPkg - The package of the file to be written.

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

Returns:

OutputStream to write to

Throws:

IOException - On IO error

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