Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.optional.javacc.JavaCC

Field Summary

Modifier and Type	Field and Description
protected static final String[]	ARCHIVE_LOCATIONS
protected static final int[]	ARCHIVE_LOCATIONS_VS_MAJOR_VERSION
private static final String	BUILD_PARSER
private static final String	BUILD_TOKEN_MANAGER
private static final String	CACHE_TOKENS
private static final String	CHOICE_AMBIGUITY_CHECK
private CommandlineJava	cmdl
protected static final String	COM_JAVACC_CLASS
protected static final String	COM_JJDOC_CLASS
protected static final String	COM_JJTREE_CLASS
protected static final String	COM_PACKAGE
private static final String	COMMON_TOKEN_ACTION
private static final String	DEBUG_LOOKAHEAD
private static final String	DEBUG_PARSER
private static final String	DEBUG_TOKEN_MANAGER
private static final String	ERROR_REPORTING
private static final String	FORCE_LA_CHECK
private static final String	IGNORE_CASE
private static final String	JAVA_UNICODE_ESCAPE
private File	javaccHome
private static final String	JDK_VERSION
private static final String	KEEP_LINE_COLUMN
private static final String	LOOKAHEAD
private String	maxMemory
private static final String	OPTIMIZE_TOKEN_MANAGER
private final Map<String, Object>	optionalAttrs
protected static final String	ORG_JAVACC_CLASS
protected static final String	ORG_JJDOC_CLASS
protected static final String	ORG_JJTREE_CLASS
protected static final String	ORG_PACKAGE_3_0
protected static final String	ORG_PACKAGE_3_1
private static final String	OTHER_AMBIGUITY_CHECK
private File	outputDirectory
private static final String	SANITY_CHECK
private static final String	STATIC
private File	targetFile
protected static final int	TASKDEF_TYPE_JAVACC
protected static final int	TASKDEF_TYPE_JJDOC
protected static final int	TASKDEF_TYPE_JJTREE
private static final String	UNICODE_INPUT
private static final String	USER_CHAR_STREAM
private static final String	USER_TOKEN_MANAGER

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	JavaCC() Constructor

Method Summary

Modifier and Type	Method and Description
public void	execute() Overrides org.apache.tools.ant.Task.execute. Run the task.
protected static File	Returns: the file object pointing to the JavaCC archive. getArchiveFile(File the javacc home path directory. home) Helper method to retrieve the path used to store the JavaCC.zip or javacc.jar which is different from versions.
private static int	Returns: the archive location index getArchiveLocationIndex(File the javacc home path directory. home) Helper method to determine the archive location index.
protected static String	Returns: the main class for the taskdef. getMainClass(File the javacc home path directory. home, int the taskdef. type) Helper method to retrieve main class which is different from versions.
protected static String	Returns: the main class for the taskdef. getMainClass(Path classpath to search in. path, int the taskdef. type) Helper method to retrieve main class which is different from versions.
protected static int	Returns: a the major version number getMajorVersionNumber(File the javacc home path directory. home) Helper method to determine the major version number of JavaCC.
private File	getOutputJavaFile(File outputdir, File srcfile) Determines the output Java file to be generated by the given grammar file.
public void	setBuildparser(boolean a `boolean` value. buildParser) Sets the BUILD_PARSER grammar option.
public void	setBuildtokenmanager(boolean a `boolean` value. buildTokenManager) Sets the BUILD_TOKEN_MANAGER grammar option.
public void	setCachetokens(boolean a `boolean` value. cacheTokens) Sets the CACHE_TOKENS grammar option.
public void	setChoiceambiguitycheck(int an `int` value. choiceAmbiguityCheck) Sets the CHOICE_AMBIGUITY_CHECK grammar option.
public void	setCommontokenaction(boolean a `boolean` value. commonTokenAction) Sets the COMMON_TOKEN_ACTION grammar option.
public void	setDebuglookahead(boolean a `boolean` value. debugLookahead) Sets the DEBUG_LOOKAHEAD grammar option.
public void	setDebugparser(boolean a `boolean` value. debugParser) Sets the DEBUG_PARSER grammar option.
public void	setDebugtokenmanager(boolean a `boolean` value. debugTokenManager) Sets the DEBUG_TOKEN_MANAGER grammar option.
public void	setErrorreporting(boolean a `boolean` value. errorReporting) Sets the ERROR_REPORTING grammar option.
public void	setForcelacheck(boolean a `boolean` value. forceLACheck) Sets the FORCE_LA_CHECK grammar option.
public void	setIgnorecase(boolean a `boolean` value. ignoreCase) Sets the IGNORE_CASE grammar option.
public void	setJavacchome(File the directory. javaccHome) The directory containing the JavaCC distribution.
public void	setJavaunicodeescape(boolean a `boolean` value. javaUnicodeEscape) Sets the JAVA_UNICODE_ESCAPE grammar option.
public void	setJDKversion(String the version to use. jdkVersion) Sets the JDK_VERSION option.
public void	setKeeplinecolumn(boolean a `boolean` value. keepLineColumn) Sets the KEEP_LINE_COLUMN grammar option.
public void	setLookahead(int an `int` value. lookahead) Sets the LOOKAHEAD grammar option.
public void	setMaxmemory(String max memory parameter. max) Corresponds -Xmx.
public void	setOptimizetokenmanager(boolean a `boolean` value. optimizeTokenManager) Sets the OPTIMIZE_TOKEN_MANAGER grammar option.
public void	setOtherambiguityCheck(int an `int` value. otherAmbiguityCheck) Sets the OTHER_AMBIGUITY_CHECK grammar option.
public void	setOutputdirectory(File the output directory. outputDirectory) The directory to write the generated files to.
public void	setSanitycheck(boolean a `boolean` value. sanityCheck) Sets the SANITY_CHECK grammar option.
public void	setStatic(boolean a `boolean` value. staticParser) Sets the STATIC grammar option.
public void	setTarget(File the grammar file. targetFile) The grammar file to process.
public void	setUnicodeinput(boolean a `boolean` value. unicodeInput) Sets the UNICODE_INPUT grammar option.
public void	setUsercharstream(boolean a `boolean` value. userCharStream) Sets the USER_CHAR_STREAM grammar option.
public void	setUsertokenmanager(boolean a `boolean` value. userTokenManager) Sets the USER_TOKEN_MANAGER grammar option.

Field Detail

ARCHIVE_LOCATIONS	back to summary
protected static final String[] ARCHIVE_LOCATIONS

ARCHIVE_LOCATIONS_VS_MAJOR_VERSION	back to summary
protected static final int[] ARCHIVE_LOCATIONS_VS_MAJOR_VERSION

BUILD_PARSER	back to summary
private static final String BUILD_PARSER

BUILD_TOKEN_MANAGER	back to summary
private static final String BUILD_TOKEN_MANAGER

CACHE_TOKENS	back to summary
private static final String CACHE_TOKENS

CHOICE_AMBIGUITY_CHECK	back to summary
private static final String CHOICE_AMBIGUITY_CHECK

cmdl	back to summary
private CommandlineJava cmdl

COM_JAVACC_CLASS	back to summary
protected static final String COM_JAVACC_CLASS

COM_JJDOC_CLASS	back to summary
protected static final String COM_JJDOC_CLASS

COM_JJTREE_CLASS	back to summary
protected static final String COM_JJTREE_CLASS

COM_PACKAGE	back to summary
protected static final String COM_PACKAGE

COMMON_TOKEN_ACTION	back to summary
private static final String COMMON_TOKEN_ACTION

DEBUG_LOOKAHEAD	back to summary
private static final String DEBUG_LOOKAHEAD

DEBUG_PARSER	back to summary
private static final String DEBUG_PARSER

DEBUG_TOKEN_MANAGER	back to summary
private static final String DEBUG_TOKEN_MANAGER

ERROR_REPORTING	back to summary
private static final String ERROR_REPORTING

FORCE_LA_CHECK	back to summary
private static final String FORCE_LA_CHECK

IGNORE_CASE	back to summary
private static final String IGNORE_CASE

JAVA_UNICODE_ESCAPE	back to summary
private static final String JAVA_UNICODE_ESCAPE

javaccHome	back to summary
private File javaccHome

JDK_VERSION	back to summary
private static final String JDK_VERSION

KEEP_LINE_COLUMN	back to summary
private static final String KEEP_LINE_COLUMN

LOOKAHEAD	back to summary
private static final String LOOKAHEAD

maxMemory	back to summary
private String maxMemory

OPTIMIZE_TOKEN_MANAGER	back to summary
private static final String OPTIMIZE_TOKEN_MANAGER

optionalAttrs	back to summary
private final Map<String, Object> optionalAttrs

ORG_JAVACC_CLASS	back to summary
protected static final String ORG_JAVACC_CLASS

ORG_JJDOC_CLASS	back to summary
protected static final String ORG_JJDOC_CLASS

ORG_JJTREE_CLASS	back to summary
protected static final String ORG_JJTREE_CLASS

ORG_PACKAGE_3_0	back to summary
protected static final String ORG_PACKAGE_3_0

ORG_PACKAGE_3_1	back to summary
protected static final String ORG_PACKAGE_3_1

OTHER_AMBIGUITY_CHECK	back to summary
private static final String OTHER_AMBIGUITY_CHECK

outputDirectory	back to summary
private File outputDirectory

SANITY_CHECK	back to summary
private static final String SANITY_CHECK

STATIC	back to summary
private static final String STATIC

targetFile	back to summary
private File targetFile

TASKDEF_TYPE_JAVACC	back to summary
protected static final int TASKDEF_TYPE_JAVACC

TASKDEF_TYPE_JJDOC	back to summary
protected static final int TASKDEF_TYPE_JJDOC

TASKDEF_TYPE_JJTREE	back to summary
protected static final int TASKDEF_TYPE_JJTREE

UNICODE_INPUT	back to summary
private static final String UNICODE_INPUT

USER_CHAR_STREAM	back to summary
private static final String USER_CHAR_STREAM

USER_TOKEN_MANAGER	back to summary
private static final String USER_TOKEN_MANAGER

Constructor Detail

JavaCC	back to summary
public JavaCC() Constructor

Method Detail

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Run the task. Annotations @Override Exceptions BuildException: on error.

execute

back to summary

public void execute() throws BuildException

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

Run the task.

Annotations

@Override

Exceptions

BuildException:: on error.

getArchiveFile	back to summary
protected static File getArchiveFile(File home) throws BuildException Helper method to retrieve the path used to store the JavaCC.zip or javacc.jar which is different from versions. Parameters home:File the javacc home path directory. Returns:File the file object pointing to the JavaCC archive. Exceptions BuildException: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getArchiveFile

back to summary

protected static File getArchiveFile(File home) throws BuildException

Helper method to retrieve the path used to store the JavaCC.zip or javacc.jar which is different from versions.

Parameters

home:File: the javacc home path directory.

Returns:File

the file object pointing to the JavaCC archive.

Exceptions

BuildException:: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getArchiveLocationIndex	back to summary
private static int getArchiveLocationIndex(File home) throws BuildException Helper method to determine the archive location index. Parameters home:File the javacc home path directory. Returns:int the archive location index Exceptions BuildException: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getArchiveLocationIndex

back to summary

private static int getArchiveLocationIndex(File home) throws BuildException

Helper method to determine the archive location index.

Parameters

home:File: the javacc home path directory.

Returns:int

the archive location index

Exceptions

BuildException:: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getMainClass	back to summary
protected static String getMainClass(File home, int type) throws BuildException Helper method to retrieve main class which is different from versions. Parameters home:File the javacc home path directory. type:int the taskdef. Returns:String the main class for the taskdef. Exceptions BuildException: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getMainClass

back to summary

protected static String getMainClass(File home, int type) throws BuildException

Helper method to retrieve main class which is different from versions.

Parameters

home:File: the javacc home path directory.
type:int: the taskdef.

Returns:String

the main class for the taskdef.

Exceptions

BuildException:: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getMainClass

back to summary

protected static String getMainClass(Path path, int type) throws BuildException

Helper method to retrieve main class which is different from versions.

Parameters

path:Path: classpath to search in.
type:int: the taskdef.

Returns:String

the main class for the taskdef.

Exceptions

BuildException:: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

Since

Ant 1.7

getMajorVersionNumber

back to summary

protected static int getMajorVersionNumber(File home) throws BuildException

Helper method to determine the major version number of JavaCC.

Parameters

home:File: the javacc home path directory.

Returns:int

a the major version number

Exceptions

BuildException:: thrown if the home directory is invalid or if the archive could not be found despite attempts to do so.

getOutputJavaFile	back to summary
private File getOutputJavaFile(File outputdir, File srcfile) Determines the output Java file to be generated by the given grammar file.

setBuildparser back to summary

public void setBuildparser(boolean buildParser)

Sets the BUILD_PARSER grammar option.

Parameters

buildParser:boolean: a boolean value.

setBuildtokenmanager back to summary

public void setBuildtokenmanager(boolean buildTokenManager)

Sets the BUILD_TOKEN_MANAGER grammar option.

Parameters

buildTokenManager:boolean: a boolean value.

setCachetokens back to summary

public void setCachetokens(boolean cacheTokens)

Sets the CACHE_TOKENS grammar option.

Parameters

cacheTokens:boolean: a boolean value.

setChoiceambiguitycheck back to summary

public void setChoiceambiguitycheck(int choiceAmbiguityCheck)

Sets the CHOICE_AMBIGUITY_CHECK grammar option.

Parameters

choiceAmbiguityCheck:int: an int value.

setCommontokenaction back to summary

public void setCommontokenaction(boolean commonTokenAction)

Sets the COMMON_TOKEN_ACTION grammar option.

Parameters

commonTokenAction:boolean: a boolean value.

setDebuglookahead back to summary

public void setDebuglookahead(boolean debugLookahead)

Sets the DEBUG_LOOKAHEAD grammar option.

Parameters

debugLookahead:boolean: a boolean value.

setDebugparser back to summary

public void setDebugparser(boolean debugParser)

Sets the DEBUG_PARSER grammar option.

Parameters

debugParser:boolean: a boolean value.

setDebugtokenmanager back to summary

public void setDebugtokenmanager(boolean debugTokenManager)

Sets the DEBUG_TOKEN_MANAGER grammar option.

Parameters

debugTokenManager:boolean: a boolean value.

setErrorreporting back to summary

public void setErrorreporting(boolean errorReporting)

Sets the ERROR_REPORTING grammar option.

Parameters

errorReporting:boolean: a boolean value.

setForcelacheck back to summary

public void setForcelacheck(boolean forceLACheck)

Sets the FORCE_LA_CHECK grammar option.

Parameters

forceLACheck:boolean: a boolean value.

setIgnorecase back to summary

public void setIgnorecase(boolean ignoreCase)

Sets the IGNORE_CASE grammar option.

Parameters

ignoreCase:boolean: a boolean value.

setJavacchome

back to summary

public void setJavacchome(File javaccHome)

The directory containing the JavaCC distribution.

Parameters

javaccHome:File: the directory.

setJavaunicodeescape back to summary

public void setJavaunicodeescape(boolean javaUnicodeEscape)

Sets the JAVA_UNICODE_ESCAPE grammar option.

Parameters

javaUnicodeEscape:boolean: a boolean value.

setJDKversion

back to summary

public void setJDKversion(String jdkVersion)

Sets the JDK_VERSION option.

Parameters

jdkVersion:String: the version to use.

Since

Ant1.7

setKeeplinecolumn back to summary

public void setKeeplinecolumn(boolean keepLineColumn)

Sets the KEEP_LINE_COLUMN grammar option.

Parameters

keepLineColumn:boolean: a boolean value.

setLookahead back to summary

public void setLookahead(int lookahead)

Sets the LOOKAHEAD grammar option.

Parameters

lookahead:int: an int value.

setMaxmemory

back to summary

public void setMaxmemory(String max)

Corresponds -Xmx.

Parameters

max:String: max memory parameter.

Since

Ant 1.8.3

setOptimizetokenmanager back to summary

public void setOptimizetokenmanager(boolean optimizeTokenManager)

Sets the OPTIMIZE_TOKEN_MANAGER grammar option.

Parameters

optimizeTokenManager:boolean: a boolean value.

setOtherambiguityCheck back to summary

public void setOtherambiguityCheck(int otherAmbiguityCheck)

Sets the OTHER_AMBIGUITY_CHECK grammar option.

Parameters

otherAmbiguityCheck:int: an int value.

setOutputdirectory

back to summary

public void setOutputdirectory(File outputDirectory)

The directory to write the generated files to. If not set, the files are written to the directory containing the grammar file.

Parameters

outputDirectory:File: the output directory.

setSanitycheck back to summary

public void setSanitycheck(boolean sanityCheck)

Sets the SANITY_CHECK grammar option.

Parameters

sanityCheck:boolean: a boolean value.

setStatic back to summary

public void setStatic(boolean staticParser)

Sets the STATIC grammar option.

Parameters

staticParser:boolean: a boolean value.

setTarget

back to summary

public void setTarget(File targetFile)

The grammar file to process.

Parameters

targetFile:File: the grammar file.

setUnicodeinput back to summary

public void setUnicodeinput(boolean unicodeInput)

Sets the UNICODE_INPUT grammar option.

Parameters

unicodeInput:boolean: a boolean value.

setUsercharstream back to summary

public void setUsercharstream(boolean userCharStream)

Sets the USER_CHAR_STREAM grammar option.

Parameters

userCharStream:boolean: a boolean value.

setUsertokenmanager back to summary

public void setUsertokenmanager(boolean userTokenManager)

Sets the USER_TOKEN_MANAGER grammar option.

Parameters

userTokenManager:boolean: a boolean value.

public Class JavaCC

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail