com.helger.pgcc.output

Class OutputFile

java.lang.Object

com.helger.pgcc.output.OutputFile

All Implemented Interfaces:

AutoCloseable

public class OutputFile
extends Object
implements AutoCloseable

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

Constructor Summary

Constructors

Constructor and Description
OutputFile(File file)
OutputFile(File file, String compatibleVersion, String[] options) Create a new OutputFile.

Method Summary

Modifier and Type	Method and Description
void	close() Close the OutputFile, writing any necessary trailer information (such as a checksum).
String	getPath()
PrintWriter	getPrintWriter() Return a PrintWriter object that may be used to write to this file.
String	getToolName()
boolean	needToWrite()
void	setToolName(String toolName)

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

getPrintWriter

@WillCloseWhenClosed
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:

the PrintWriter to use.

Throws:

IOException

close

public void close()

Close the OutputFile, writing any necessary trailer information (such as a checksum).

Specified by:

close in interface AutoCloseable

getToolName

public String getToolName()

Returns:

the toolName

setToolName

public void setToolName(String toolName)

Parameters:

toolName - the toolName to set

getPath

public String getPath()

needToWrite

public boolean needToWrite()