com.helger.jcodemodel.writer

Class PrologCodeWriter

java.lang.Object

com.helger.jcodemodel.writer.AbstractCodeWriter

com.helger.jcodemodel.writer.FilterCodeWriter

com.helger.jcodemodel.writer.PrologCodeWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class PrologCodeWriter
extends FilterCodeWriter

Writes all the source files under the specified file folder and inserts a file prolog comment in each java source file.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
PrologCodeWriter(AbstractCodeWriter aCore, String prolog)

Method Summary

Modifier and Type	Method and Description
SourcePrintWriter	openSource(JPackage pkg, String fileName) Called by CodeModel to store the specified file.

Methods inherited from class com.helger.jcodemodel.writer.FilterCodeWriter

close, core, openBinary

Methods inherited from class com.helger.jcodemodel.writer.AbstractCodeWriter

encoding, getNewLine

Methods inherited from class java.lang.Object

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

Constructor Detail

PrologCodeWriter

public PrologCodeWriter(@Nonnull
                        AbstractCodeWriter aCore,
                        @Nullable
                        String prolog)

Parameters:

aCore - This CodeWriter will be used to actually create a storage for files. PrologCodeWriter simply decorates this underlying CodeWriter by adding prolog comments.

prolog - Strings that will be added as comments. This string may contain newlines to produce multi-line comments. '//' will be inserted at the beginning of each line to make it a valid Java comment, so the caller can just pass strings like "abc\ndef"

Method Detail

openSource

public SourcePrintWriter openSource(@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.

Overrides:

openSource in class FilterCodeWriter

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