public class ReplacerMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
basedir
Optional base directory for each file to replace.
|
private boolean |
commentsEnabled
Comments enabled in the tokenValueMapFile.
|
private java.util.List<java.lang.String> |
delimiters
Add a list of delimiters which are added on either side of tokens to match against.
|
private java.lang.String |
encoding
File encoding used when reading and writing files.
|
private java.util.List<java.lang.String> |
excludes
List of files to exclude for multiple (or single) replacement.
|
private java.lang.String |
file
File to check and replace tokens.
|
private java.util.List<java.lang.String> |
files
list files
|
private FileSelector |
fileSelector |
private java.lang.String |
filesToExclude
List of comma separated files to exclude (must have some includes) for multiple (or single) replacement.
|
private java.lang.String |
filesToInclude
Comma separated list of includes.
|
private FileUtils |
fileUtils |
private boolean |
ignoreErrors
Ignore any errors produced by this plugin such as
files not being found and continue with the build.
|
private boolean |
ignoreMissingFile
Ignore missing target file.
|
private java.util.List<java.lang.String> |
includes
List of files to include for multiple (or single) replacement.
|
private java.lang.String |
inputFilePattern
Regular expression is run on an input file's name to create the output file with.
|
private static java.lang.String |
INVALID_IGNORE_MISSING_FILE_MESSAGE |
private java.lang.Integer |
maxReplacements
Set a maximum number of files which can be replaced per execution.
|
private java.lang.String |
outputBasedir
Base directory (appended) to use for outputDir.
|
private java.lang.String |
outputDir
Output to another dir.
|
private java.lang.String |
outputFile
Output to another file.
|
private OutputFilenameBuilder |
outputFilenameBuilder |
private java.lang.String |
outputFilePattern
Regular expression groups from inputFilePattern are used in this pattern to create an output file per input file.
|
private java.util.List<java.lang.String> |
outputFiles
list out put file
|
private PatternFlagsFactory |
patternFlagsFactory |
private boolean |
preserveDir
Parent directory is preserved when replacing files found from includes and
being written to an outputDir.
|
private ReplacementProcessor |
processor |
private boolean |
quiet
Stops printing a summary of files that have had replacements performed upon them when true.
|
private boolean |
regex
Indicates if the token should be located with regular expressions.
|
private static java.lang.String |
REGEX_PATTERN_WITH_DELIMITERS_MESSAGE |
private java.util.List<java.lang.String> |
regexFlags
List of standard Java regular expression Pattern flags (see Java Doc).
|
private java.util.List<Replacement> |
replacements
List of replacements with token/value pairs.
|
private ReplacerFactory |
replacerFactory |
private boolean |
skip
Skip running this plugin.
|
private SummaryBuilder |
summaryBuilder |
private java.lang.String |
token
Token to replace.
|
private java.lang.String |
tokenFile
Token file containing a token to be replaced in the target file/s.
|
private java.lang.String |
tokenValueMap
Map of tokens and respective values to replace with.
|
private TokenValueMapFactory |
tokenValueMapFactory |
private boolean |
unescape
Unescape tokens and values to Java format.
|
private java.lang.String |
value
Value to replace token with.
|
private java.lang.String |
valueFile
A file containing a value to replace the given token with.
|
private java.lang.String |
variableTokenValueMap
Variable tokenValueMap.
|
private java.lang.String |
xpath
X-Path expression for locating node's whose content you wish to replace.
|
Constructor and Description |
---|
ReplacerMojo() |
ReplacerMojo(FileUtils fileUtils,
ReplacementProcessor processor,
ReplacerFactory replacerFactory,
TokenValueMapFactory tokenValueMapFactory,
FileSelector fileSelector,
PatternFlagsFactory patternFlagsFactory,
OutputFilenameBuilder outputFilenameBuilder,
SummaryBuilder summaryBuilder) |
Modifier and Type | Method and Description |
---|---|
private void |
addIncludesFilesAndExcludedFiles() |
private void |
addToList(java.util.List<java.lang.String> toAdds,
java.util.List<java.lang.String> destination) |
private java.util.List<DelimiterBuilder> |
buildDelimiters() |
private java.util.List<Replacement> |
buildReplacements() |
private boolean |
checkFileExists() |
void |
execute() |
java.lang.String |
getBasedir() |
private java.lang.String |
getBaseDirPrefixedFilename(java.lang.String file) |
private java.util.List<Replacement> |
getDelimiterReplacements(java.util.List<Replacement> replacements) |
java.util.List<java.lang.String> |
getDelimiters() |
java.util.List<java.lang.String> |
getExcludes() |
java.lang.String |
getFile() |
java.util.List<java.lang.String> |
getFiles() |
java.lang.String |
getFilesToExclude() |
java.lang.String |
getFilesToInclude() |
java.util.List<java.lang.String> |
getIncludes() |
java.lang.String |
getInputFilePattern() |
java.lang.String |
getOutputBasedir() |
java.lang.String |
getOutputDir() |
java.lang.String |
getOutputFile() |
java.lang.String |
getOutputFilePattern() |
java.util.List<java.lang.String> |
getOutputFiles() |
java.lang.String |
getVariableTokenValueMap() |
boolean |
isCommentsEnabled() |
boolean |
isIgnoreErrors() |
boolean |
isPreserveDir() |
boolean |
isSkip() |
boolean |
isUnescape() |
private <T> java.util.List<T> |
limit(java.util.List<T> all) |
private void |
replaceContents(ReplacementProcessor processor,
java.util.List<Replacement> replacements,
java.util.List<java.lang.String> inputFiles) |
private void |
replaceContents(ReplacementProcessor processor,
java.util.List<Replacement> replacements,
java.lang.String inputFile) |
void |
setBasedir(java.lang.String baseDir) |
void |
setCommentsEnabled(boolean commentsEnabled) |
void |
setDelimiters(java.util.List<java.lang.String> delimiters) |
void |
setEncoding(java.lang.String encoding) |
void |
setExcludes(java.util.List<java.lang.String> excludes) |
void |
setFile(java.lang.String file) |
void |
setFiles(java.util.List<java.lang.String> files) |
void |
setFilesToExclude(java.lang.String filesToExclude) |
void |
setFilesToInclude(java.lang.String filesToInclude) |
void |
setIgnoreErrors(boolean ignoreErrors) |
void |
setIgnoreMissingFile(boolean ignoreMissingFile) |
void |
setIncludes(java.util.List<java.lang.String> includes) |
void |
setInputFilePattern(java.lang.String inputFilePattern) |
void |
setMaxReplacements(java.lang.Integer maxReplacements) |
void |
setOutputBasedir(java.lang.String outputBasedir) |
void |
setOutputDir(java.lang.String outputDir) |
void |
setOutputFile(java.lang.String outputFile) |
void |
setOutputFilePattern(java.lang.String outputFilePattern) |
void |
setOutputFiles(java.util.List<java.lang.String> outputFiles) |
void |
setPreserveDir(boolean preserveDir) |
void |
setQuiet(boolean quiet) |
void |
setRegex(boolean regex) |
void |
setRegexFlags(java.util.List<java.lang.String> regexFlags) |
void |
setReplacements(java.util.List<Replacement> replacements) |
void |
setSkip(boolean skip) |
void |
setToken(java.lang.String token) |
void |
setTokenFile(java.lang.String tokenFile) |
void |
setTokenValueMap(java.lang.String tokenValueMap) |
void |
setUnescape(boolean unescape) |
void |
setValue(java.lang.String value) |
void |
setValueFile(java.lang.String valueFile) |
void |
setVariableTokenValueMap(java.lang.String variableTokenValueMap) |
void |
setXpath(java.lang.String xpath) |
private static final java.lang.String INVALID_IGNORE_MISSING_FILE_MESSAGE
private static final java.lang.String REGEX_PATTERN_WITH_DELIMITERS_MESSAGE
private final FileUtils fileUtils
private final ReplacerFactory replacerFactory
private final TokenValueMapFactory tokenValueMapFactory
private final FileSelector fileSelector
private final PatternFlagsFactory patternFlagsFactory
private final OutputFilenameBuilder outputFilenameBuilder
private final SummaryBuilder summaryBuilder
private final ReplacementProcessor processor
private java.lang.String file
private java.util.List<java.lang.String> includes
private java.util.List<java.lang.String> excludes
private java.lang.String filesToInclude
private java.lang.String filesToExclude
private java.lang.String token
private java.lang.String tokenFile
private boolean ignoreMissingFile
private java.lang.String value
private java.lang.String valueFile
private boolean regex
private java.lang.String outputFile
private java.lang.String outputDir
private java.lang.String tokenValueMap
private java.lang.String basedir
private java.util.List<java.lang.String> regexFlags
private java.util.List<Replacement> replacements
private boolean commentsEnabled
private boolean skip
private java.lang.String outputBasedir
private boolean preserveDir
private boolean quiet
private boolean unescape
private java.util.List<java.lang.String> delimiters
private java.lang.String variableTokenValueMap
private boolean ignoreErrors
private java.lang.String xpath
private java.lang.String encoding
private java.lang.String inputFilePattern
private java.lang.String outputFilePattern
private java.lang.Integer maxReplacements
private java.util.List<java.lang.String> files
private java.util.List<java.lang.String> outputFiles
public ReplacerMojo()
public ReplacerMojo(FileUtils fileUtils, ReplacementProcessor processor, ReplacerFactory replacerFactory, TokenValueMapFactory tokenValueMapFactory, FileSelector fileSelector, PatternFlagsFactory patternFlagsFactory, OutputFilenameBuilder outputFilenameBuilder, SummaryBuilder summaryBuilder)
public void execute() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private <T> java.util.List<T> limit(java.util.List<T> all)
private boolean checkFileExists() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private java.lang.String getBaseDirPrefixedFilename(java.lang.String file)
private void addIncludesFilesAndExcludedFiles()
private void addToList(java.util.List<java.lang.String> toAdds, java.util.List<java.lang.String> destination)
private void replaceContents(ReplacementProcessor processor, java.util.List<Replacement> replacements, java.lang.String inputFile) throws java.io.IOException
java.io.IOException
private void replaceContents(ReplacementProcessor processor, java.util.List<Replacement> replacements, java.util.List<java.lang.String> inputFiles) throws java.io.IOException
java.io.IOException
private java.util.List<Replacement> buildReplacements() throws java.io.IOException
java.io.IOException
private java.util.List<Replacement> getDelimiterReplacements(java.util.List<Replacement> replacements)
private java.util.List<DelimiterBuilder> buildDelimiters()
public void setRegex(boolean regex)
public void setFile(java.lang.String file)
public java.lang.String getFile()
public void setToken(java.lang.String token)
public void setValue(java.lang.String value)
public void setTokenFile(java.lang.String tokenFile)
public void setValueFile(java.lang.String valueFile)
public void setIgnoreMissingFile(boolean ignoreMissingFile)
public void setOutputFile(java.lang.String outputFile)
public void setTokenValueMap(java.lang.String tokenValueMap)
public void setFilesToInclude(java.lang.String filesToInclude)
public void setFilesToExclude(java.lang.String filesToExclude)
public void setBasedir(java.lang.String baseDir)
public void setReplacements(java.util.List<Replacement> replacements)
public void setRegexFlags(java.util.List<java.lang.String> regexFlags)
public void setIncludes(java.util.List<java.lang.String> includes)
public java.util.List<java.lang.String> getIncludes()
public void setExcludes(java.util.List<java.lang.String> excludes)
public java.util.List<java.lang.String> getExcludes()
public java.lang.String getFilesToInclude()
public java.lang.String getFilesToExclude()
public void setOutputDir(java.lang.String outputDir)
public boolean isCommentsEnabled()
public void setCommentsEnabled(boolean commentsEnabled)
public void setOutputBasedir(java.lang.String outputBasedir)
public boolean isPreserveDir()
public void setPreserveDir(boolean preserveDir)
public java.lang.String getBasedir()
public java.lang.String getOutputDir()
public java.lang.String getOutputBasedir()
public java.lang.String getOutputFile()
public void setQuiet(boolean quiet)
public void setDelimiters(java.util.List<java.lang.String> delimiters)
public java.util.List<java.lang.String> getDelimiters()
public void setUnescape(boolean unescape)
public boolean isUnescape()
public void setVariableTokenValueMap(java.lang.String variableTokenValueMap)
public java.lang.String getVariableTokenValueMap()
public void setIgnoreErrors(boolean ignoreErrors)
public boolean isIgnoreErrors()
public void setXpath(java.lang.String xpath)
public void setEncoding(java.lang.String encoding)
public void setInputFilePattern(java.lang.String inputFilePattern)
public void setOutputFilePattern(java.lang.String outputFilePattern)
public java.lang.String getInputFilePattern()
public java.lang.String getOutputFilePattern()
public void setSkip(boolean skip)
public boolean isSkip()
public void setMaxReplacements(java.lang.Integer maxReplacements)
public java.util.List<java.lang.String> getFiles()
public void setFiles(java.util.List<java.lang.String> files)
public java.util.List<java.lang.String> getOutputFiles()
public void setOutputFiles(java.util.List<java.lang.String> outputFiles)