AntlrTask (Gradle API 2.0)

org.gradle.api.plugins.antlr.AntlrTask

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.

Inherited fields
Fields inherited from class	Fields
`class SourceTask`	`source`

Methods Summary

Methods
Type	Name 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)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class SourceTask`	`exclude, exclude, exclude, exclude, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source`

- Method Detail
  - @TaskAction public void generate()
  - @InputFiles public FileCollection getAntlrClasspath()
    
    Returns the classpath containing the Ant ANTLR task implementation.
    Returns:
    The Ant task implementation classpath.
  - @OutputDirectory public File getOutputDirectory()
    
    Returns the directory to generate the parser source files into.
    Returns:
    The output directory.
  - public boolean isTrace()
    
    Specifies that all rules call traceIn/traceOut.
  - public boolean isTraceLexer()
    
    Specifies that all lexer rules call traceIn/traceOut.
  - public boolean isTraceParser()
    
    Specifies that all parser rules call traceIn/traceOut.
  - public boolean isTraceTreeWalker()
    
    Specifies that all tree walker rules call traceIn/traceOut.
  - 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.
  - public void setOutputDirectory(File outputDirectory)
    
    Specifies the directory to generate the parser source files into.
    Parameters:
    outputDirectory - The output directory. Must not be null.
  - public void setTrace(boolean trace)
  - public void setTraceLexer(boolean traceLexer)
  - public void setTraceParser(boolean traceParser)
  - public void setTraceTreeWalker(boolean traceTreeWalker)

Summary:
Method

| Detail:
Method

Gradle API 2.0

[Java] Class AntlrTask

Methods Summary

Inherited Methods Summary

Method Detail

@TaskAction public void generate()

@InputFiles public FileCollection getAntlrClasspath()

@OutputDirectory public File getOutputDirectory()

public boolean isTrace()

public boolean isTraceLexer()

public boolean isTraceParser()

public boolean isTraceTreeWalker()

public void setAntlrClasspath(FileCollection antlrClasspath)

public void setOutputDirectory(File outputDirectory)

public void setTrace(boolean trace)

public void setTraceLexer(boolean traceLexer)

public void setTraceParser(boolean traceParser)

public void setTraceTreeWalker(boolean traceTreeWalker)