AntlrTask (Gradle API 2.3)

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, ExtensionAware, Task, PatternFilterable, org.gradle.util.Configurable<Task>
```
public class AntlrTask
extends SourceTask
```
Generates parsers from Antlr grammars.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  Task.Namer

Field Summary
- Fields inherited from class org.gradle.api.tasks.SourceTask
  source
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor and Description

AntlrTask()

Constructors
Constructor and Description
`AntlrTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`evaluateAntlrResult(org.gradle.api.plugins.antlr.internal.AntlrResult result)`
`void`	`execute(IncrementalTaskInputs inputs)`
`FileCollection`	`getAntlrClasspath()` Returns the classpath containing the Ant ANTLR task implementation.
`List<String>`	`getArguments()`
`String`	`getMaxHeapSize()` The maximum heap size for the forked antlr process (ex: '1g').
`File`	`getOutputDirectory()` Returns the directory to generate the parser source files into.
`org.gradle.internal.Factory<org.gradle.process.internal.WorkerProcessBuilder>`	`getWorkerProcessBuilderFactory()`
`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`.
`protected void`	`setAntlrClasspath(FileCollection antlrClasspath)` Specifies the classpath containing the Ant ANTLR task implementation.
`void`	`setArguments(List<String> arguments)`
`void`	`setMaxHeapSize(String maxHeapSize)`
`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)`

Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AntlrTask
```
public AntlrTask()
```
- Method Detail
  - isTrace
```
public boolean isTrace()
```
    Specifies that all rules call traceIn/traceOut.
  - setTrace
```
public void setTrace(boolean trace)
```
  - isTraceLexer
```
public boolean isTraceLexer()
```
    Specifies that all lexer rules call traceIn/traceOut.
  - setTraceLexer
```
public void setTraceLexer(boolean traceLexer)
```
  - isTraceParser
```
public boolean isTraceParser()
```
    Specifies that all parser rules call traceIn/traceOut.
  - setTraceParser
```
public void setTraceParser(boolean traceParser)
```
  - isTraceTreeWalker
```
public boolean isTraceTreeWalker()
```
    Specifies that all tree walker rules call traceIn/traceOut.
  - setTraceTreeWalker
```
public void setTraceTreeWalker(boolean traceTreeWalker)
```
  - getMaxHeapSize
```
public String getMaxHeapSize()
```
    The maximum heap size for the forked antlr process (ex: '1g').
  - setMaxHeapSize
```
public void setMaxHeapSize(String maxHeapSize)
```
  - setArguments
```
public void setArguments(List<String> arguments)
```
  - getArguments
```
@Input
public List<String> getArguments()
```
  - getOutputDirectory
```
@OutputDirectory
public File getOutputDirectory()
```
    Returns the directory to generate the parser source files into.
    
    Returns:
    The output directory.
  - setOutputDirectory
```
public void setOutputDirectory(File outputDirectory)
```
    Specifies the directory to generate the parser source files into.
    
    Parameters:
    outputDirectory - The output directory. Must not be null.
  - getAntlrClasspath
```
@InputFiles
public FileCollection getAntlrClasspath()
```
    Returns the classpath containing the Ant ANTLR task implementation.
    
    Returns:
    The Ant task implementation classpath.
  - setAntlrClasspath
```
protected void setAntlrClasspath(FileCollection antlrClasspath)
```
    Specifies the classpath containing the Ant ANTLR task implementation.
    
    Parameters:
    antlrClasspath - The Ant task implementation classpath. Must not be null.
  - getWorkerProcessBuilderFactory
```
@Inject
public org.gradle.internal.Factory<org.gradle.process.internal.WorkerProcessBuilder> getWorkerProcessBuilderFactory()
```
  - execute
```
public void execute(IncrementalTaskInputs inputs)
```
  - evaluateAntlrResult
```
public void evaluateAntlrResult(org.gradle.api.plugins.antlr.internal.AntlrResult result)
```

Class AntlrTask

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from class org.gradle.api.tasks.SourceTask

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.tasks.SourceTask

Methods inherited from class org.gradle.api.internal.ConventionTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Constructor Detail

AntlrTask

Method Detail

isTrace

setTrace

isTraceLexer

setTraceLexer

isTraceParser

setTraceParser

isTraceTreeWalker

setTraceTreeWalker

getMaxHeapSize

setMaxHeapSize

setArguments

getArguments

getOutputDirectory

setOutputDirectory

getAntlrClasspath

setAntlrClasspath

getWorkerProcessBuilderFactory

execute

evaluateAntlrResult