public class AntlrTask extends SourceTask
Generates parsers from Antlr grammars.
Most properties here are self-evident, but I wanted to highlight one in particular: setAntlrClasspath(org.gradle.api.file.FileCollection) is
used to define the classpath that should be passed along to the Ant ANTLR task as its classpath. That is the
classpath it uses to perform generation execution. This should really only require the antlr jar. In AntlrPlugin usage, this would happen simply by adding your antlr jar into the 'antlr' dependency configuration
created and exposed by the AntlrPlugin itself.
Task.NamerTASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor and Description |
|---|
AntlrTask() |
| Modifier and Type | Method and Description |
|---|---|
void |
generate() |
FileCollection |
getAntlrClasspath()
Returns the classpath containing the Ant ANTLR task implementation.
|
File |
getOutputDirectory()
Returns the directory to generate the parser source files into.
|
boolean |
isTrace()
Specifies that all rules call
traceIn/traceOut. |
boolean |
isTraceLexer()
Specifies that all lexer rules call
traceIn/traceOut. |
boolean |
isTraceParser()
Specifies that all parser rules call
traceIn/traceOut. |
boolean |
isTraceTreeWalker()
Specifies that all tree walker rules call
traceIn/traceOut. |
void |
setAntlrClasspath(FileCollection antlrClasspath)
Specifies the classpath containing the Ant ANTLR task implementation.
|
void |
setOutputDirectory(File outputDirectory)
Specifies the directory to generate the parser source files into.
|
void |
setTrace(boolean trace) |
void |
setTraceLexer(boolean traceLexer) |
void |
setTraceParser(boolean traceParser) |
void |
setTraceTreeWalker(boolean traceTreeWalker) |
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, sourceconventionMapping, conventionMapping, getConventionMappingaddValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toStringpublic boolean isTrace()
traceIn/traceOut.public void setTrace(boolean trace)
public boolean isTraceLexer()
traceIn/traceOut.public void setTraceLexer(boolean traceLexer)
public boolean isTraceParser()
traceIn/traceOut.public void setTraceParser(boolean traceParser)
public boolean isTraceTreeWalker()
traceIn/traceOut.public void setTraceTreeWalker(boolean traceTreeWalker)
public File getOutputDirectory()
public void setOutputDirectory(File outputDirectory)
outputDirectory - The output directory. Must not be null.public FileCollection getAntlrClasspath()
public void setAntlrClasspath(FileCollection antlrClasspath)
antlrClasspath - The Ant task implementation classpath. Must not be null.public void generate()