Class OutputFile

java.lang.Object

org.javacc.utils.OutputFile

All Implemented Interfaces:

Closeable, AutoCloseable

class OutputFile
extends Object
implements Closeable

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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	OutputFile.TrapClosePrintWriter	The OutputFile.TrapClosePrintWriter implements a PrintWriter, avoiding to close the related OutputStream with an OutputFile.TrapClosePrintWriter.close().

Field Summary

Fields

Modifier and Type	Field	Description
private final String	compatibleVersion
private DigestOutputStream	digestStream
private final File	file
private final boolean	needToWrite
private final List<String>	options
private final String	toolName
private OutputFile.TrapClosePrintWriter	writer

Constructor Summary

Constructors

Constructor	Description
OutputFile(File file, String toolName, String compatibleVersion, List<String> options, Context context)	Create a new OutputFile.

Method Summary

Modifier and Type	Method	Description
final void	close()	Close the OutputFile, writing any necessary trailer information (such as a checksum).
final PrintWriter	getPrintWriter()	Return a PrintWriter object that may be used to write to this file.
final boolean	isNeedToWrite()	Return true if the file needs to be written.

Methods inherited from class Object

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

Field Details

file

private final File file

options

private final List<String> options

toolName

private final String toolName

compatibleVersion

private final String compatibleVersion

needToWrite

private final boolean needToWrite

writer

private OutputFile.TrapClosePrintWriter writer

digestStream

private DigestOutputStream digestStream

Constructor Details

OutputFile

OutputFile(File file,
 String toolName,
 String compatibleVersion,
 List<String> options,
 Context context)
    throws IOException

Create a new OutputFile.

Parameters:

file - the file to write to.

toolName - the name of the generating tool.

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

Method Details

isNeedToWrite

public final boolean isNeedToWrite()

Return true if the file needs to be written.

getPrintWriter

public final 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.

Throws:

IOException

close

public final void close()
                 throws IOException

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException