Package org.gradle.api.plugins.antlr
Class AntlrTask
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.plugins.antlr.AntlrTask
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
Generates parsers from Antlr grammars.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute(InputChanges inputChanges) Generate the parsers.Returns the classpath containing the Ant ANTLR task implementation.List of command-line arguments passed to the antlr processprotected org.gradle.internal.file.DeleterThe maximum heap size for the forked antlr process (ex: '1g').Returns the directory to generate the parser source files into.protected ProjectLayoutReturns the source for this task, after the include and exclude patterns have been applied.protected FileCollectionThe sources for incremental change detection.protected org.gradle.process.internal.worker.WorkerProcessFactorybooleanisTrace()Specifies that all rules calltraceIn/traceOut.booleanSpecifies that all lexer rules calltraceIn/traceOut.booleanSpecifies that all parser rules calltraceIn/traceOut.booleanSpecifies that all tree walker rules calltraceIn/traceOut.protected voidsetAntlrClasspath(FileCollection antlrClasspath) Specifies the classpath containing the Ant ANTLR task implementation.voidsetArguments(List<String> arguments) voidsetMaxHeapSize(String maxHeapSize) voidsetOutputDirectory(File outputDirectory) Specifies the directory to generate the parser source files into.voidSets the source for this task.voidSets the source for this task.voidsetTrace(boolean trace) voidsetTraceLexer(boolean traceLexer) voidsetTraceParser(boolean traceParser) voidsetTraceTreeWalker(boolean traceTreeWalker) Methods inherited from class org.gradle.api.tasks.SourceTaskexclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, sourceMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
AntlrTaskpublic AntlrTask()
 
- 
- 
Method Details- 
isTraceSpecifies that all rules calltraceIn/traceOut.
- 
setTracepublic void setTrace(boolean trace) 
- 
isTraceLexerSpecifies that all lexer rules calltraceIn/traceOut.
- 
setTraceLexerpublic void setTraceLexer(boolean traceLexer) 
- 
isTraceParserSpecifies that all parser rules calltraceIn/traceOut.
- 
setTraceParserpublic void setTraceParser(boolean traceParser) 
- 
isTraceTreeWalkerSpecifies that all tree walker rules calltraceIn/traceOut.
- 
setTraceTreeWalkerpublic void setTraceTreeWalker(boolean traceTreeWalker) 
- 
getMaxHeapSizeThe maximum heap size for the forked antlr process (ex: '1g').
- 
setMaxHeapSize
- 
setArguments
- 
getArgumentsList of command-line arguments passed to the antlr process- Returns:
- The antlr command-line arguments
 
- 
getOutputDirectoryReturns the directory to generate the parser source files into.- Returns:
- The output directory.
 
- 
setOutputDirectorySpecifies the directory to generate the parser source files into.- Parameters:
- outputDirectory- The output directory. Must not be null.
 
- 
getAntlrClasspathReturns the classpath containing the Ant ANTLR task implementation.- Returns:
- The Ant task implementation classpath.
 
- 
setAntlrClasspathSpecifies the classpath containing the Ant ANTLR task implementation.- Parameters:
- antlrClasspath- The Ant task implementation classpath. Must not be null.
 
- 
getWorkerProcessBuilderFactory@Inject protected org.gradle.process.internal.worker.WorkerProcessFactory getWorkerProcessBuilderFactory()
- 
getProjectLayout
- 
executeGenerate the parsers.- Since:
- 6.0
 
- 
setSourceSets the source for this task. Delegates tosetSource(Object). If the source is of typeSourceDirectorySet, then the relative path of each source grammar files is used to determine the relative output path of the generated source If the source is not of typeSourceDirectorySet, then the generated source files end up flattened in the specified output directory.- Overrides:
- setSourcein class- SourceTask
- Parameters:
- source- The source.
- Since:
- 4.0
 
- 
setSourceSets the source for this task. Delegates toSourceTask.setSource(Object). If the source is of typeSourceDirectorySet, then the relative path of each source grammar files is used to determine the relative output path of the generated source If the source is not of typeSourceDirectorySet, then the generated source files end up flattened in the specified output directory.- Overrides:
- setSourcein class- SourceTask
- Parameters:
- source- The source.
 
- 
getSourceReturns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Overrides:
- getSourcein class- SourceTask
- Returns:
- The source.
 
- 
getStableSources@SkipWhenEmpty @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles protected FileCollection getStableSources()The sources for incremental change detection.- Since:
- 6.0
 
- 
getDeleter@Inject protected org.gradle.internal.file.Deleter getDeleter()
 
-