Class OutputFile

java.lang.Object
org.javacc.parser.OutputFile

public class OutputFile extends Object
This class handles the creation and maintenance of the boiler-plate classes, such as Token.java, JavaCharStream.java etc. It is responsible for:
  • Writing the JavaCC header lines to the file.
  • Writing the checksum line.
  • Using the checksum to determine if an existing file has been changed by the user (and so should be left alone).
  • Checking any existing file's version (if the file can not be overwritten).
  • Checking any existing file's creation options (if the file can not be overwritten).
Author:
Paul Cager
  • Field Details

    • needToWrite

      public boolean needToWrite
  • Constructor Details

    • OutputFile

      public OutputFile(File file, String compatibleVersion, String[] options) throws IOException
      Create a new OutputFile.
      Parameters:
      file - the file to write to.
      compatibleVersion - the minimum compatible JavaCC version.
      options - if the file already exists, and cannot be overwritten, this is a list of options (such s STATIC=false) to check for changes.
      Throws:
      IOException
    • OutputFile

      public OutputFile(File file) throws IOException
      Throws:
      IOException
  • Method Details

    • getPrintWriter

      public PrintWriter getPrintWriter() throws IOException
      Return a PrintWriter object that may be used to write to this file. Any necessary header information is written by this method.
      Returns:
      Throws:
      IOException
    • close

      public void close() throws IOException
      Close the OutputFile, writing any necessary trailer information (such as a checksum).
      Throws:
      IOException
    • getToolName

      public String getToolName()
      Returns:
      the toolName
    • setToolName

      public void setToolName(String toolName)
      Parameters:
      toolName - the toolName to set
    • getPath

      public String getPath()