com.helger.jcodemodel.writer

Class ZipCodeWriter

java.lang.Object

com.helger.jcodemodel.writer.AbstractCodeWriter

com.helger.jcodemodel.writer.ZipCodeWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZipCodeWriter
extends AbstractCodeWriter

Writes all the files into a zip file.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
ZipCodeWriter(OutputStream target)
ZipCodeWriter(OutputStream target, String sNewLine)

Method Summary

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

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

encoding, getNewLine, openSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipCodeWriter

public ZipCodeWriter(@Nonnull
                     OutputStream target)

Parameters:

target - Zip file will be written to this stream.

ZipCodeWriter

public ZipCodeWriter(@Nonnull
                     OutputStream target,
                     @Nonnull
                     String sNewLine)

Parameters:

target - Zip file will be written to this stream.

sNewLine - The new line string to be used for source files

Method Detail

openBinary

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

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