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, Task, PatternFilterable, org.gradle.util.Configurable<Task>

public class AntlrTask
extends SourceTask

Gradle task for executing Antlr generations. Wrapper around the Ant ANTLR task.

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.

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

AntlrTask()

Method Summary

void	generate()
FileCollection	getAntlrClasspath()
File	getOutputDirectory()
boolean	isTrace()
boolean	isTraceLexer()
boolean	isTraceParser()
boolean	isTraceTreeWalker()
void	setAntlrClasspath(FileCollection antlrClasspath)
void	setOutputDirectory(File outputDirectory)
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, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source

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

conventionMapping, getConventionMapping, setConventionMapping

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

captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, hashCode, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

captureStandardOutput, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, getActions, getAnt, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getGroup, getInputs, getLogger, getLogging, getName, getOutputs, getPath, getProject, getState, getTaskDependencies, getTemporaryDir, hasProperty, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setEnabled, setGroup, setOnlyIf, setOnlyIf, setProperty

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AntlrTask

public AntlrTask()

Method Detail

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)

isTraceLexer

public boolean isTraceLexer()

setTraceLexer

public void setTraceLexer(boolean traceLexer)

isTraceParser

public boolean isTraceParser()

setTraceParser

public void setTraceParser(boolean traceParser)

isTraceTreeWalker

public boolean isTraceTreeWalker()

setTraceTreeWalker

public void setTraceTreeWalker(boolean traceTreeWalker)

getOutputDirectory

public File getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

getAntlrClasspath

public FileCollection getAntlrClasspath()

setAntlrClasspath

public void setAntlrClasspath(FileCollection antlrClasspath)

generate

public void generate()