Class 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)
    • Constructor Detail

      • PrologCodeWriter

        public PrologCodeWriter​(CodeWriter core,
                                java.lang.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 java.io.Writer openSource​(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.

        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:
        java.io.IOException