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.
since: Ant 1.1
setFile(File file) Set the source file; required unless dir is set.
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.
public void
setReplaceFilterFile(File filename) Sets the name of a property file containing filters; optional.
helper method to load a properties file and throw a build exception
if it cannot be loaded
Parameters: propertyFile - the file to load the properties from loaded properties collection throws: BuildException - if the file could not be found or read
Set the file encoding to use on the files read and written by the task;
optional, defaults to default JVM encoding
Parameters: encoding - the encoding to use on the files
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.
Parameters: filename - file to load
setReplaceFilterFile
public void setReplaceFilterFile(File filename)(Code)
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.
Parameters: filename - file to load
Indicates whether a summary of the replace operation should be
produced, detailing how many token occurrences and files were
processed; optional, default=false
Parameters: summary - true if you would like a summary logged of thereplace operation
Set the string token to replace;
required unless a nested
replacetoken element or the replacefilterfile
attribute is used.
Parameters: token - token string
Set the string value to use as token replacement;
optional, default is the empty string ""
Parameters: value - replacement value
validateAttributes
public void validateAttributes() throws BuildException(Code)
Validate attributes provided for this task in .xml build file.
exception: BuildException - if any supplied attribute is invalid or anymandatory attribute is missing
validateReplacefilters
public void validateReplacefilters() throws BuildException(Code)
Validate nested elements.
exception: BuildException - if any supplied attribute is invalid or anymandatory attribute is missing