jdeparser 1.0.0.Final-redhat-1

org.jboss.jdeparser.writer
Class PrologCodeWriter

java.lang.Object
  extended by org.jboss.jdeparser.CodeWriter
      extended by org.jboss.jdeparser.writer.FilterCodeWriter
          extended by org.jboss.jdeparser.writer.PrologCodeWriter

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)

Field Summary
 
Fields inherited from class org.jboss.jdeparser.writer.FilterCodeWriter
core
 
Fields inherited from class org.jboss.jdeparser.CodeWriter
encoding
 
Constructor Summary
PrologCodeWriter(CodeWriter core, String prolog)
           
 
Method Summary
 Writer openSource(JPackage pkg, String fileName)
          Called by JDeparser to store the specified file.
 
Methods inherited from class org.jboss.jdeparser.writer.FilterCodeWriter
close, openBinary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrologCodeWriter

public PrologCodeWriter(CodeWriter core,
                        String prolog)
Parameters:
core - 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 Writer openSource(JPackage pkg,
                         String fileName)
                  throws IOException
Description copied from class: CodeWriter
Called by JDeparser 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

jdeparser 1.0.0.Final-redhat-1

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.