Top Description Fields Constructors Methods
org.apache.tools.ant.taskdefs.optional.javacc

public Class JJDoc

extends Task
Class Inheritance
Imports
java.io.File, .IOException, java.util.Hashtable, .Map, org.apache.tools.ant.BuildException, .Project, .Task, org.apache.tools.ant.taskdefs.Execute, .LogStreamHandler, org.apache.tools.ant.types.Commandline, .CommandlineJava, .Path, org.apache.tools.ant.util.JavaEnvUtils
Runs the JJDoc compiler compiler.

Field Summary

Modifier and TypeField and Description
private CommandlineJava
cmdl

private static final String
DEFAULT_SUFFIX_HTML

private static final String
DEFAULT_SUFFIX_TEXT

private File
javaccHome

private String
maxMemory

private static final String
ONE_TABLE

private final Map<String, Object>
optionalAttrs

private static final String
OUTPUT_FILE

private String
outputFile

private boolean
plainText

private File
targetFile

private static final String
TEXT

Inherited from org.apache.tools.ant.Task:
targettaskNametaskTypewrapper

Constructor Summary

AccessConstructor and Description
public
JJDoc()

Constructor

Method Summary

Modifier and TypeMethod and Description
private String
createOutputFileName(File destFile, String optionalOutputFile, boolean plain)

public void
execute()

Overrides org.apache.tools.ant.Task.execute.

Do the task.
public void
setJavacchome(File
the home directory.
javaccHome)

The directory containing the JavaCC distribution.

public void
setMaxmemory(String
max memory parameter.
max)

Corresponds -Xmx.

public void
setOnetable(boolean
a boolean value.
oneTable)

Sets the ONE_TABLE documentation option.

public void
setOutputfile(String
the name of the output file.
outputFile)

The outputfile to write the generated BNF documentation file to.

public void
setTarget(File
the grammar file.
target)

The javacc grammar file to process.

public void
setText(boolean
a boolean value.
plainText)

Sets the TEXT BNF documentation option.

Inherited from org.apache.tools.ant.Task:
bindToOwnergetOwningTargetgetRuntimeConfigurableWrappergetTaskNamegetTaskTypegetWrapperhandleErrorFlushhandleErrorOutputhandleFlushhandleInputhandleOutputinitisInvalidloglogloglogmaybeConfigureperformreconfiguresetOwningTargetsetRuntimeConfigurableWrappersetTaskNamesetTaskType

Field Detail

cmdlback to summary
private CommandlineJava cmdl
DEFAULT_SUFFIX_HTMLback to summary
private static final String DEFAULT_SUFFIX_HTML
DEFAULT_SUFFIX_TEXTback to summary
private static final String DEFAULT_SUFFIX_TEXT
javaccHomeback to summary
private File javaccHome
maxMemoryback to summary
private String maxMemory
ONE_TABLEback to summary
private static final String ONE_TABLE
optionalAttrsback to summary
private final Map<String, Object> optionalAttrs
OUTPUT_FILEback to summary
private static final String OUTPUT_FILE
outputFileback to summary
private String outputFile
plainTextback to summary
private boolean plainText
targetFileback to summary
private File targetFile
TEXTback to summary
private static final String TEXT

Constructor Detail

JJDocback to summary
public JJDoc()

Constructor

Method Detail

createOutputFileNameback to summary
private String createOutputFileName(File destFile, String optionalOutputFile, boolean plain)
executeback to summary
public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Do the task.

Annotations
@Override
Exceptions
BuildException:
if there is an error.
setJavacchomeback to summary
public void setJavacchome(File javaccHome)

The directory containing the JavaCC distribution.

Parameters
javaccHome:File

the home directory.

setMaxmemoryback to summary
public void setMaxmemory(String max)

Corresponds -Xmx.

Parameters
max:String

max memory parameter.

Since
Ant 1.8.3
setOnetableback to summary
public void setOnetable(boolean oneTable)

Sets the ONE_TABLE documentation option.

Parameters
oneTable:boolean

a boolean value.

setOutputfileback to summary
public void setOutputfile(String outputFile)

The outputfile to write the generated BNF documentation file to. If not set, the file is written with the same name as the JavaCC grammar file with a suffix .html or .txt.

Parameters
outputFile:String

the name of the output file.

setTargetback to summary
public void setTarget(File target)

The javacc grammar file to process.

Parameters
target:File

the grammar file.

setTextback to summary
public void setText(boolean plainText)

Sets the TEXT BNF documentation option.

Parameters
plainText:boolean

a boolean value.