@Mojo(name="preprocess", defaultPhase=GENERATE_SOURCES, threadSafe=true, requiresProject=true) public class PreprocessorMojo extends org.apache.maven.plugin.AbstractMojo implements PreprocessorLogger
Modifier and Type | Field and Description |
---|---|
private boolean |
careForLastNextLine
Be precise in processing of the last next line char in files, it will not be added if it is not presented if to turn on the mode..
|
private java.io.File[] |
cfgFiles
List of external configuration files.
|
private boolean |
clear
Clear the destination folder before preprocessing (if it exists).
|
private boolean |
compareDestination
Flag to compare generated content with existing file and if it is the same then to not override the file, it brings overhead
|
private java.util.List<java.lang.String> |
compileSourceRoots
The Project source roots for non-test mode.
|
private java.io.File |
destination
The Destination folder where generated sources will be placed in non-test mode.
|
private boolean |
disableOut
Make dry run of the preprocessor without any saving of result.
|
private java.lang.String |
excluded
List of file extensions to be excluded from the preprocessing process.
|
private java.util.Properties |
globalVars
List of global preprocessing variables.
|
private java.lang.String |
inEncoding
The Input text encoding to be used for preprocessing, by default it uses defined in project properties.
|
private boolean |
keepLines
Disable removing lines from preprocessed files, it allows to keep line numeration similar to original sources.
|
private boolean |
keepSrcRoot
Disable overriding of the source root folders for maven project after preprocessing.
|
private java.lang.String |
outEncoding
The Encoding for preprocessed text output, by default it uses defined in
project properties.
|
private java.lang.String |
processing
List of file extensions to be preprocessed.
|
private org.apache.maven.project.MavenProject |
project
The Maven Project to be preprocessed.
|
private boolean |
removeComments
Remove all Java like commentaries from preprocessed sources.
|
private java.lang.String |
source
The Directly defined source directory, it will make plugin to preprocess the folder instead of project and maven defined ones.
|
private java.util.List<java.lang.String> |
testCompileSourceRoots
The Project source roots for test mode.
|
private java.io.File |
testDestination
Destination folder where generated sources will be placed in test-mode.
|
private boolean |
useTestSources
Allow usage of the preprocessor for test sources (since 5.3.4 version).
|
private boolean |
verbose
Turn on the verbose mode for preprocessing process.
|
Constructor and Description |
---|
PreprocessorMojo() |
Modifier and Type | Method and Description |
---|---|
void |
debug(java.lang.String message)
Log a debug message
|
void |
error(java.lang.String message)
Log an error message
|
void |
execute() |
boolean |
getCarForLastNextLine() |
java.io.File[] |
getCfgFiles() |
boolean |
getClear() |
java.io.File |
getDestination() |
boolean |
getDisableOut() |
java.lang.String |
getExcluded() |
java.util.Properties |
getGlobalVars() |
java.lang.String |
getInEncoding() |
boolean |
getKeepLines() |
boolean |
getKeepSrcRoot() |
java.lang.String |
getOutEncoding() |
java.lang.String |
getProcessing() |
boolean |
getRemoveComments() |
java.lang.String |
getSource() |
java.io.File |
getTestDestination() |
boolean |
getUseTestSources() |
boolean |
getVerbose() |
void |
info(java.lang.String message)
Log an information message
|
boolean |
isCompareDestination() |
(package private) PreprocessorContext |
makePreprocessorContext() |
private java.lang.String |
makeSourceRootList() |
private void |
replaceSourceRootByPreprocessingDestinationFolder(PreprocessorContext context) |
void |
setCareForLastNextLine(boolean flag) |
void |
setCfgFiles(java.io.File[] files) |
void |
setClear(boolean flag) |
void |
setCompareDestination(boolean flag) |
void |
setDestination(java.io.File destination) |
void |
setDisableOut(boolean value) |
void |
setExcluded(java.lang.String excluded) |
void |
setGlobalVars(java.util.Properties vars) |
void |
setInEncoding(java.lang.String value) |
void |
setKeepLines(boolean keepLines) |
void |
setKeepSrcRoot(boolean flag) |
void |
setOutEncoding(java.lang.String value) |
void |
setProcessing(java.lang.String processing) |
void |
setRemoveComments(boolean value) |
void |
setSource(java.lang.String source) |
void |
setTestDestination(java.io.File destination) |
void |
setUseTestSources(boolean flag) |
void |
setVerbose(boolean verbose) |
void |
warning(java.lang.String message)
Log a warning message
|
@Parameter(name="compileSourceRoots", defaultValue="${project.compileSourceRoots}", required=true, readonly=true) private java.util.List<java.lang.String> compileSourceRoots
@Parameter(name="testCompileSourceRoots", defaultValue="${project.testCompileSourceRoots}", required=true, readonly=true) private java.util.List<java.lang.String> testCompileSourceRoots
@Parameter(defaultValue="${project}", required=true, readonly=true) private org.apache.maven.project.MavenProject project
@Parameter(name="source", defaultValue="") private java.lang.String source
@Parameter(name="destination", defaultValue="${project.build.directory}/generated-sources/preprocessed") private java.io.File destination
@Parameter(name="testDestination", defaultValue="${project.build.directory}/generated-test-sources/preprocessed") private java.io.File testDestination
@Parameter(name="inEncoding", defaultValue="${project.build.sourceEncoding}") private java.lang.String inEncoding
@Parameter(name="outEncoding", defaultValue="${project.build.sourceEncoding}") private java.lang.String outEncoding
@Parameter(name="excluded") private java.lang.String excluded
@Parameter(name="processing") private java.lang.String processing
@Parameter(name="disableOut", defaultValue="false") private boolean disableOut
@Parameter(name="verbose", defaultValue="false") private boolean verbose
@Parameter(name="clear", defaultValue="false") private boolean clear
@Parameter(name="careForLastNextLine", defaultValue="false") private boolean careForLastNextLine
@Parameter(name="keepSrcRoot", defaultValue="false") private boolean keepSrcRoot
@Parameter(name="removeComments", defaultValue="false") private boolean removeComments
@Parameter(name="globalVars") private java.util.Properties globalVars
@Parameter(name="cfgFiles") private java.io.File[] cfgFiles
@Parameter(name="keepLines", defaultValue="true") private boolean keepLines
@Parameter(name="useTestSources", defaultValue="false") private boolean useTestSources
@Parameter(name="compareDestination", defaultValue="false") private boolean compareDestination
public void setUseTestSources(boolean flag)
public boolean getUseTestSources()
public void setClear(boolean flag)
public boolean getClear()
public void setCareForLastNextLine(boolean flag)
public boolean getCarForLastNextLine()
public void setKeepSrcRoot(boolean flag)
public boolean getKeepSrcRoot()
public void setGlobalVars(java.util.Properties vars)
public java.util.Properties getGlobalVars()
public void setCfgFiles(java.io.File[] files)
public java.io.File[] getCfgFiles()
public void setCompareDestination(boolean flag)
public boolean isCompareDestination()
public void setSource(java.lang.String source)
public java.lang.String getSource()
public void setDestination(java.io.File destination)
public java.io.File getDestination()
public void setTestDestination(java.io.File destination)
public java.io.File getTestDestination()
public void setInEncoding(java.lang.String value)
public java.lang.String getInEncoding()
public void setOutEncoding(java.lang.String value)
public java.lang.String getOutEncoding()
public void setExcluded(java.lang.String excluded)
public java.lang.String getExcluded()
public void setProcessing(java.lang.String processing)
public java.lang.String getProcessing()
public void setDisableOut(boolean value)
public boolean getDisableOut()
public void setVerbose(boolean verbose)
public boolean getVerbose()
public void setKeepLines(boolean keepLines)
public boolean getKeepLines()
public void setRemoveComments(boolean value)
public boolean getRemoveComments()
private java.lang.String makeSourceRootList()
private void replaceSourceRootByPreprocessingDestinationFolder(PreprocessorContext context) throws java.io.IOException
java.io.IOException
PreprocessorContext makePreprocessorContext() throws java.io.IOException
java.io.IOException
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
public void error(java.lang.String message)
PreprocessorLogger
error
in interface PreprocessorLogger
message
- the text to be output into the error logpublic void info(java.lang.String message)
PreprocessorLogger
info
in interface PreprocessorLogger
message
- the text to be output into the information logpublic void warning(java.lang.String message)
PreprocessorLogger
warning
in interface PreprocessorLogger
message
- the text to be output into the warning logpublic void debug(java.lang.String message)
PreprocessorLogger
debug
in interface PreprocessorLogger
message
- the text to be output into the information log