Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.plugins.antlr
[Java] Class AntlrTask

java.lang.Object
  org.gradle.api.internal.ConventionTask
      org.gradle.api.tasks.SourceTask
          org.gradle.api.plugins.antlr.AntlrTask

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 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 class SourceTask
source
 
Method Summary
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)

 
Methods inherited from class SourceTask
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source
 

Method Detail

generate

@TaskAction
public void generate()

getAntlrClasspath

@InputFiles
public FileCollection getAntlrClasspath()
Returns the classpath containing the Ant ANTLR task implementation.
Returns:
The Ant task implementation classpath.

getOutputDirectory

@OutputDirectory
public File getOutputDirectory()
Returns the directory to generate the parser source files into.
Returns:
The output directory.

isTrace

public boolean isTrace()
Specifies that all rules call traceIn/traceOut.

isTraceLexer

public boolean isTraceLexer()
Specifies that all lexer rules call traceIn/traceOut.

isTraceParser

public boolean isTraceParser()
Specifies that all parser rules call traceIn/traceOut.

isTraceTreeWalker

public boolean isTraceTreeWalker()
Specifies that all tree walker rules call traceIn/traceOut.

setAntlrClasspath

public void setAntlrClasspath(FileCollection antlrClasspath)
Specifies the classpath containing the Ant ANTLR task implementation.
Parameters:
antlrClasspath - The Ant task implementation classpath. Must not be null.

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.

setTrace

public void setTrace(boolean trace)

setTraceLexer

public void setTraceLexer(boolean traceLexer)

setTraceParser

public void setTraceParser(boolean traceParser)

setTraceTreeWalker

public void setTraceTreeWalker(boolean traceTreeWalker)

 

Gradle API 1.12