com.sun.codemodel.writer
Class SingleStreamCodeWriter

java.lang.Object
  extended by com.sun.codemodel.CodeWriter
      extended by com.sun.codemodel.writer.SingleStreamCodeWriter

public class SingleStreamCodeWriter
extends CodeWriter

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
SingleStreamCodeWriter(java.io.OutputStream os)
           
 
Method Summary
 void close()
          Called by CodeModel at the end of the process.
 java.io.OutputStream openBinary(JPackage pkg, java.lang.String fileName)
          Called by CodeModel to store the specified file.
 
Methods inherited from class com.sun.codemodel.CodeWriter
openSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SingleStreamCodeWriter

public SingleStreamCodeWriter(java.io.OutputStream os)
Parameters:
os - This stream will be closed at the end of the code generation.
Method Detail

openBinary

public java.io.OutputStream openBinary(JPackage pkg,
                                       java.lang.String fileName)
                                throws java.io.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.

Specified by:
openBinary in class CodeWriter
Parameters:
pkg - The package of the file to be written.
fileName - File name without the path. Something like "Foo.java" or "Bar.properties"
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Description copied from class: CodeWriter
Called by CodeModel at the end of the process.

Specified by:
close in class CodeWriter
Throws:
java.io.IOException


Copyright © 2005-2008 Sun Microsystems. All Rights Reserved.