org.apache.tools.ant.taskdefs
Class Replace
- SelectorContainer
Replaces all occurrences of one or more string tokens with given
values in the indicated files. Each value can be either a string
or the value of a property available in a designated property file.
If you want to replace a text that crosses line boundaries, you
must use a nested <replacetoken> element.
Replace.NestedString | createReplaceToken()- the token to filter as the text of a nested element
|
Replace.NestedString | createReplaceValue()- the string to replace the token as the text of a nested element
|
Replace.Replacefilter | createReplacefilter()- Add a nested <replacefilter> element.
|
void | execute()- Do the execution.
|
Properties | getProperties(File propertyFile)- helper method to load a properties file and throw a build exception
if it cannot be loaded
|
void | setDir(File dir)- The base directory to use when replacing a token in multiple files;
required if
file is not defined.
|
void | setEncoding(String encoding)- Set the file encoding to use on the files read and written by the task;
optional, defaults to default JVM encoding
|
void | setFile(File file)- Set the source file; required unless
dir is set.
|
void | setPropertyFile(File filename)- The name of a property file from which properties specified using
nested
<replacefilter> elements are drawn;
Required only if property attribute of
<replacefilter> is used.
|
void | setReplaceFilterFile(File filename)- Sets the name of a property file containing filters; optional.
|
void | setSummary(boolean summary)- Indicates whether a summary of the replace operation should be
produced, detailing how many token occurrences and files were
processed; optional, default=false
|
void | setToken(String token)- Set the string token to replace;
required unless a nested
replacetoken element or the replacefilterfile
attribute is used.
|
void | setValue(String value)- Set the string value to use as token replacement;
optional, default is the empty string ""
|
void | validateAttributes()- Validate attributes provided for this task in .xml build file.
|
void | validateReplacefilters()- Validate nested elements.
|
XsetIgnore, XsetItems, add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject |
execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
createReplaceToken
public Replace.NestedString createReplaceToken()
the token to filter as the text of a nested element
- nested token to configure
createReplaceValue
public Replace.NestedString createReplaceValue()
the string to replace the token as the text of a nested element
- replacement value to configure
createReplacefilter
public Replace.Replacefilter createReplacefilter()
Add a nested <replacefilter> element.
- a nested ReplaceFilter object to be configured
getProperties
public Properties getProperties(File propertyFile)
throws BuildException helper method to load a properties file and throw a build exception
if it cannot be loaded
propertyFile - the file to load the properties from
- loaded properties collection
setDir
public void setDir(File dir)
The base directory to use when replacing a token in multiple files;
required if file is not defined.
setEncoding
public void setEncoding(String encoding)
Set the file encoding to use on the files read and written by the task;
optional, defaults to default JVM encoding
encoding - the encoding to use on the files
setFile
public void setFile(File file)
Set the source file; required unless dir is set.
setPropertyFile
public void setPropertyFile(File filename)
The name of a property file from which properties specified using
nested <replacefilter> elements are drawn;
Required only if property attribute of
<replacefilter> is used.
setReplaceFilterFile
public void setReplaceFilterFile(File filename)
Sets the name of a property file containing filters; optional.
Each property will be treated as a
replacefilter where token is the name of the property and value
is the value of the property.
setSummary
public void setSummary(boolean summary)
Indicates whether a summary of the replace operation should be
produced, detailing how many token occurrences and files were
processed; optional, default=false
summary - true if you would like a summary logged of the
replace operation
setToken
public void setToken(String token)
Set the string token to replace;
required unless a nested
replacetoken element or the replacefilterfile
attribute is used.
setValue
public void setValue(String value)
Set the string value to use as token replacement;
optional, default is the empty string ""
value - replacement value
validateAttributes
public void validateAttributes()
throws BuildException Validate attributes provided for this task in .xml build file.
BuildException - if any supplied attribute is invalid or any
mandatory attribute is missing
validateReplacefilters
public void validateReplacefilters()
throws BuildException Validate nested elements.
BuildException - if any supplied attribute is invalid or any
mandatory attribute is missing
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.