javacc:javacc
Full name:
org.codehaus.mojo:javacc-maven-plugin:3.0.1:javacc
Description:
Parses a JavaCC grammar file (
*.jj
) and transforms it
to Java source files. Detailed information about the JavaCC options
can be found on the JavaCC
website.Attributes:
- Requires a Maven project to be executed.
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
2.0
. - Binds by default to the lifecycle phase:
generate-sources
.
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<buildParser> |
Boolean |
2.0 |
A flag that controls whether the parser file
(*Parser.java ) should be generated or not. If set to
false , only the token manager is generated. Default
value is true .User property is: javacc.buildParser . |
<buildTokenManager> |
Boolean |
2.0 |
A flag that controls whether the token manager file
(*TokenManager.java ) should be generated or not.
Setting this to false can speed up the generation
process if only the parser part of the grammar changed. Default
value is true .User property is: javacc.buildTokenManager . |
<cacheTokens> |
Boolean |
2.0 |
Setting this option to true causes the generated
parser to lookahead for extra tokens ahead of time. Default value
is false .User property is: javacc.cacheTokens . |
<choiceAmbiguityCheck> |
Integer |
2.0 |
This is the number of tokens considered in checking choices of the
form "A | B | ..." for ambiguity. Default value is 2 .User property is: javacc.choiceAmbiguityCheck . |
<commonTokenAction> |
Boolean |
2.0 |
When set to true , every call to the token manager's
method getNextToken() (see the description of the Java
Compiler Compiler API) will cause a call to a user-defined
method CommonTokenAction() after the token has been
scanned in by the token manager. Default value is
false .User property is: javacc.commonTokenAction . |
<debugLookAhead> |
Boolean |
2.0 |
This is a boolean option whose default value is false .
Setting this option to true causes the parser to
generate all the tracing information it does when the option
debugParser is true , and in addition,
also causes it to generated a trace of actions performed during
lookahead operation.User property is: javacc.debugLookAhead . |
<debugParser> |
Boolean |
2.0 |
This option is used to obtain debugging information from the
generated parser. Setting this option to true causes
the parser to generate a trace of its actions. Default value is
false .User property is: javacc.debugParser . |
<debugTokenManager> |
Boolean |
2.0 |
This option is used to obtain debugging information from the
generated token manager. Default value is false .User property is: javacc.debugTokenManager . |
<errorReporting> |
Boolean |
2.0 |
Setting it to false causes errors due to parse errors
to be reported in somewhat less detail. Default value is
true .User property is: javacc.errorReporting . |
<excludes> |
String[] |
2.0 |
A set of Ant-like exclusion patterns used to prevent certain files
from being processed. By default, this set is empty such that no
files are excluded. |
<forceLaCheck> |
Boolean |
2.0 |
This option setting controls lookahead ambiguity checking performed
by JavaCC. Default value is false .User property is: javacc.forceLaCheck . |
<grammarEncoding> |
String |
2.6 |
The file encoding to use for reading the grammar files. Default value is: ${project.build.sourceEncoding} .User property is: javacc.grammarEncoding . |
<ignoreCase> |
Boolean |
2.0 |
Setting this option to true causes the generated token
manager to ignore case in the token specifications and the input
files. Default value is false .User property is: javacc.ignoreCase . |
<includes> |
String[] |
2.0 |
A set of Ant-like inclusion patterns used to select files from the
source directory for processing. By default, the patterns
**/*.jj and **/*.JJ are used to select
grammar files. |
<isStatic> |
Boolean |
2.0 |
If true , all methods and class variables are specified
as static in the generated parser and token manager. This allows
only one parser object to be present, but it improves the
performance of the parser. Default value is true .User property is: javacc.isStatic . |
<javaUnicodeEscape> |
Boolean |
2.0 |
When set to true , the generated parser uses an input
stream object that processes Java Unicode escapes
(\ u xxxx) before sending characters
to the token manager. Default value is false .User property is: javacc.javaUnicodeEscape . |
<jdkVersion> |
String |
2.4 |
The Java version for which to generate source code. Default value
is 1.5 for plugin version 2.6+ and 1.4 in
older versions.User property is: javacc.jdkVersion . |
<keepLineColumn> |
Boolean |
2.0 |
A flag whether to keep line and column information along with a
token. Default value is true .User property is: javacc.keepLineColumn . |
<lookAhead> |
Integer |
2.0 |
The number of tokens to look ahead before making a decision at a
choice point during parsing. The default value is 1 .User property is: javacc.lookAhead . |
<otherAmbiguityCheck> |
Integer |
2.0 |
This is the number of tokens considered in checking all other kinds
of choices (i.e., of the forms "(A)*", "(A)+", and "(A)?") for
ambiguity. Default value is 1 .User property is: javacc.otherAmbiguityCheck . |
<outputDirectory> |
File |
2.0 |
The directory where the parser files generated by JavaCC will be
stored. The directory will be registered as a compile source root
of the project such that the generated files will participate in
later build phases like compiling and packaging. Default value is: ${project.build.directory}/generated-sources/javacc .User property is: javacc.outputDirectory . |
<packageName> |
String |
2.0 |
Deprecated. As of version 2.4 because the plugin extracts the package name from
each grammar file. User property is: javacc.packageName . |
<sanityCheck> |
Boolean |
2.0 |
Enables/disables many syntactic and semantic checks on the grammar
file during parser generation. Default value is true .User property is: javacc.sanityCheck . |
<sourceDirectory> |
File |
2.0 |
The directory where the JavaCC grammar files (*.jj )
are located.Default value is: ${basedir}/src/main/javacc .User property is: javacc.sourceDirectory . |
<staleMillis> |
int |
2.0 |
The granularity in milliseconds of the last modification date for
testing whether a source needs recompilation. Default value is: 0 .User property is: javacc.lastModGranularityMs . |
<supportClassVisibilityPublic> |
Boolean |
2.6 |
A flag whether the generated support classes of the parser should
have public or package-private visibility. Default value is
true .User property is: javacc.supportClassVisibilityPublic . |
<tokenExtends> |
String |
2.5 |
The name of the base class for the generated Token
class. Default value is java.lang.Object .User property is: javacc.tokenExtends . |
<tokenFactory> |
String |
2.5 |
The name of a custom factory class used to create
Token objects. This class must have a method with the
signature public static Token newToken(int ofKind, String
image) . By default, tokens are created by calling
Token.newToken() .User property is: javacc.tokenFactory . |
<tokenManagerUsesParser> |
Boolean |
2.0 |
When set to true , the generated token manager will
include a field called parser that references the
instantiating parser instance. Default value is false .User property is: javacc.tokenManagerUsesParser . |
<unicodeInput> |
Boolean |
2.0 |
When set to true , the generated parser uses uses an
input stream object that reads Unicode files. By default, ASCII
files are assumed. Default value is false .User property is: javacc.unicodeInput . |
<userCharStream> |
Boolean |
2.0 |
This flag controls whether the token manager will read characters
from a character stream reader as defined by the options
javaUnicodeEscape and unicodeInput or
whether the token manager reads from a user-supplied implementation
of CharStream . Default value is false .User property is: javacc.userCharStream . |
<userTokenManager> |
Boolean |
2.0 |
The default action is to generate a token manager that works on the
specified grammar tokens. If this option is set to
true , then the parser is generated to accept tokens
from any token manager of type TokenManager - this
interface is generated into the generated parser directory. Default
value is false .User property is: javacc.userTokenManager . |
Parameter Details
<buildParser>
A flag that controls whether the parser file
(
*Parser.java
) should be generated or not. If set to
false
, only the token manager is generated. Default
value is true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.buildParser
<buildTokenManager>
A flag that controls whether the token manager file
(
*TokenManager.java
) should be generated or not.
Setting this to false
can speed up the generation
process if only the parser part of the grammar changed. Default
value is true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.buildTokenManager
<cacheTokens>
Setting this option to
true
causes the generated
parser to lookahead for extra tokens ahead of time. Default value
is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.cacheTokens
<choiceAmbiguityCheck>
This is the number of tokens considered in checking choices of the
form "A | B | ..." for ambiguity. Default value is
2
.- Type:
java.lang.Integer
- Since:
2.0
- Required:
No
- User Property:
javacc.choiceAmbiguityCheck
<commonTokenAction>
When set to
true
, every call to the token manager's
method getNextToken()
(see the description of the Java
Compiler Compiler API) will cause a call to a user-defined
method CommonTokenAction()
after the token has been
scanned in by the token manager. Default value is
false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.commonTokenAction
<debugLookAhead>
This is a boolean option whose default value is
false
.
Setting this option to true
causes the parser to
generate all the tracing information it does when the option
debugParser
is true
, and in addition,
also causes it to generated a trace of actions performed during
lookahead operation.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.debugLookAhead
<debugParser>
This option is used to obtain debugging information from the
generated parser. Setting this option to
true
causes
the parser to generate a trace of its actions. Default value is
false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.debugParser
<debugTokenManager>
This option is used to obtain debugging information from the
generated token manager. Default value is
false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.debugTokenManager
<errorReporting>
Setting it to
false
causes errors due to parse errors
to be reported in somewhat less detail. Default value is
true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.errorReporting
<excludes>
A set of Ant-like exclusion patterns used to prevent certain files
from being processed. By default, this set is empty such that no
files are excluded.
- Type:
java.lang.String[]
- Since:
2.0
- Required:
No
<forceLaCheck>
This option setting controls lookahead ambiguity checking performed
by JavaCC. Default value is
false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.forceLaCheck
<grammarEncoding>
The file encoding to use for reading the grammar files.
- Type:
java.lang.String
- Since:
2.6
- Required:
No
- User Property:
javacc.grammarEncoding
- Default:
${project.build.sourceEncoding}
<ignoreCase>
Setting this option to
true
causes the generated token
manager to ignore case in the token specifications and the input
files. Default value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.ignoreCase
<includes>
A set of Ant-like inclusion patterns used to select files from the
source directory for processing. By default, the patterns
**/*.jj
and **/*.JJ
are used to select
grammar files.- Type:
java.lang.String[]
- Since:
2.0
- Required:
No
<isStatic>
If
true
, all methods and class variables are specified
as static in the generated parser and token manager. This allows
only one parser object to be present, but it improves the
performance of the parser. Default value is true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.isStatic
<javaUnicodeEscape>
When set to
true
, the generated parser uses an input
stream object that processes Java Unicode escapes
(\
u
xxxx) before sending characters
to the token manager. Default value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.javaUnicodeEscape
<jdkVersion>
The Java version for which to generate source code. Default value
is
1.5
for plugin version 2.6+ and 1.4
in
older versions.- Type:
java.lang.String
- Since:
2.4
- Required:
No
- User Property:
javacc.jdkVersion
<keepLineColumn>
A flag whether to keep line and column information along with a
token. Default value is
true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.keepLineColumn
<lookAhead>
The number of tokens to look ahead before making a decision at a
choice point during parsing. The default value is
1
.- Type:
java.lang.Integer
- Since:
2.0
- Required:
No
- User Property:
javacc.lookAhead
<otherAmbiguityCheck>
This is the number of tokens considered in checking all other kinds
of choices (i.e., of the forms "(A)*", "(A)+", and "(A)?") for
ambiguity. Default value is
1
.- Type:
java.lang.Integer
- Since:
2.0
- Required:
No
- User Property:
javacc.otherAmbiguityCheck
<outputDirectory>
The directory where the parser files generated by JavaCC will be
stored. The directory will be registered as a compile source root
of the project such that the generated files will participate in
later build phases like compiling and packaging.
- Type:
java.io.File
- Since:
2.0
- Required:
No
- User Property:
javacc.outputDirectory
- Default:
${project.build.directory}/generated-sources/javacc
<packageName>
Deprecated. As of version 2.4 because the plugin extracts the package name from
each grammar file.
Package into which the generated classes will be put. Note that
this will also be used to create the directory structure where
sources will be generated. Defaults to the package name specified
in a grammar file.
- Type:
java.lang.String
- Since:
2.0
- Required:
No
- User Property:
javacc.packageName
<sanityCheck>
Enables/disables many syntactic and semantic checks on the grammar
file during parser generation. Default value is
true
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.sanityCheck
<sourceDirectory>
The directory where the JavaCC grammar files (
*.jj
)
are located.- Type:
java.io.File
- Since:
2.0
- Required:
No
- User Property:
javacc.sourceDirectory
- Default:
${basedir}/src/main/javacc
<staleMillis>
The granularity in milliseconds of the last modification date for
testing whether a source needs recompilation.
- Type:
int
- Since:
2.0
- Required:
No
- User Property:
javacc.lastModGranularityMs
- Default:
0
<supportClassVisibilityPublic>
A flag whether the generated support classes of the parser should
have public or package-private visibility. Default value is
true
.- Type:
java.lang.Boolean
- Since:
2.6
- Required:
No
- User Property:
javacc.supportClassVisibilityPublic
<tokenExtends>
The name of the base class for the generated
Token
class. Default value is java.lang.Object
.- Type:
java.lang.String
- Since:
2.5
- Required:
No
- User Property:
javacc.tokenExtends
<tokenFactory>
The name of a custom factory class used to create
Token
objects. This class must have a method with the
signature public static Token newToken(int ofKind, String
image)
. By default, tokens are created by calling
Token.newToken()
.- Type:
java.lang.String
- Since:
2.5
- Required:
No
- User Property:
javacc.tokenFactory
<tokenManagerUsesParser>
When set to
true
, the generated token manager will
include a field called parser
that references the
instantiating parser instance. Default value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.tokenManagerUsesParser
<unicodeInput>
When set to
true
, the generated parser uses uses an
input stream object that reads Unicode files. By default, ASCII
files are assumed. Default value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.unicodeInput
<userCharStream>
This flag controls whether the token manager will read characters
from a character stream reader as defined by the options
javaUnicodeEscape
and unicodeInput
or
whether the token manager reads from a user-supplied implementation
of CharStream
. Default value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.userCharStream
<userTokenManager>
The default action is to generate a token manager that works on the
specified grammar tokens. If this option is set to
true
, then the parser is generated to accept tokens
from any token manager of type TokenManager
- this
interface is generated into the generated parser directory. Default
value is false
.- Type:
java.lang.Boolean
- Since:
2.0
- Required:
No
- User Property:
javacc.userTokenManager