Javadox

• Java Articles
• Maven Dependency

com.sun.codemodel.writer
Class ProgressCodeWriter

java.lang.Object  com.sun.codemodel.CodeWriter      com.sun.codemodel.writer.FilterCodeWriter          com.sun.codemodel.writer.ProgressCodeWriter

public class ProgressCodeWriter

extends FilterCodeWriter

Filter CodeWriter that writes a progress message to the specified PrintStream.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Field Summary

Fields inherited from class com.sun.codemodel.writer.FilterCodeWriter

core

Fields inherited from class com.sun.codemodel.CodeWriter

encoding

Constructor Summary

ProgressCodeWriter(CodeWriter output, PrintStream progress)

Method Summary

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 com.sun.codemodel.writer.FilterCodeWriter

close

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressCodeWriter

public ProgressCodeWriter(CodeWriter output,                          PrintStream progress)

Method Detail

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.

Overrides:

openBinary 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"

Throws:

IOException

openSource

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

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"

Throws:

IOException