|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.javacc.AbstractPreprocessorMojo
public abstract class AbstractPreprocessorMojo
Provides common services for all mojos that preprocess JavaCC grammar files.
Field Summary |
---|
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractPreprocessorMojo()
|
Method Summary | |
---|---|
protected void |
addCompileSourceRoot()
Registers the configured output directory as a compile source root for the current project. |
protected void |
createTimestamp(org.codehaus.mojo.javacc.GrammarInfo grammarInfo)
Creates the timestamp file for the specified grammar file. |
void |
execute()
Execute the tool. |
protected abstract String[] |
getExcludes()
Gets a set of Ant-like exclusion patterns used to unselect files from the source directory for processing. |
protected abstract String[] |
getIncludes()
Gets a set of Ant-like inclusion patterns used to select files from the source directory for processing. |
protected abstract File |
getOutputDirectory()
Gets the absolute path to the directory where the generated Java files for the parser will be stored. |
protected abstract File |
getSourceDirectory()
Gets the absolute path to the directory where the grammar files are located. |
protected abstract int |
getStaleMillis()
Gets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation. |
protected abstract File |
getTimestampDirectory()
Gets the absolute path to the directory where the processed input files will be stored for later detection of stale sources. |
protected abstract void |
processGrammar(org.codehaus.mojo.javacc.GrammarInfo grammarInfo)
Passes the specified grammar file through the tool. |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractPreprocessorMojo()
Method Detail |
---|
protected abstract File getSourceDirectory()
null
.protected abstract String[] getIncludes()
null
if all files should be included.protected abstract String[] getExcludes()
null
if no files should be excluded.protected abstract File getOutputDirectory()
null
.protected abstract File getTimestampDirectory()
null
.protected abstract int getStaleMillis()
public void execute() throws MojoExecutionException, MojoFailureException
MojoExecutionException
- If the invocation of the tool failed.
MojoFailureException
- If the tool reported a non-zero exit code.protected abstract void processGrammar(org.codehaus.mojo.javacc.GrammarInfo grammarInfo) throws MojoExecutionException, MojoFailureException
grammarInfo
- The grammar info describing the grammar file to process, must not be null
.
MojoExecutionException
- If the invocation of the tool failed.
MojoFailureException
- If the tool reported a non-zero exit code.protected void createTimestamp(org.codehaus.mojo.javacc.GrammarInfo grammarInfo)
grammarInfo
- The grammar info describing the grammar file to process, must not be null
.protected void addCompileSourceRoot()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |