|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.Replace
public class Replace
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.
| Nested Class Summary | |
|---|---|
class |
Replace.NestedString
An inline string to use as the replacement text. |
class |
Replace.Replacefilter
A filter to apply. |
| Field Summary |
|---|
| Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
|---|
fileset |
| Fields inherited from class org.apache.tools.ant.Task |
|---|
target, taskName, taskType, wrapper |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
|---|
description, location, project |
| Constructor Summary | |
|---|---|
Replace()
|
|
| Method Summary | |
|---|---|
void |
addConfigured(ResourceCollection rc)
Support arbitrary file system based resource collections. |
Replace.Replacefilter |
createReplacefilter()
Add a nested <replacefilter> element. |
Replace.NestedString |
createReplaceToken()
Create a token to filter as the text of a nested element. |
Replace.NestedString |
createReplaceValue()
Create a string to replace the token as the text of a nested element. |
void |
execute()
Do the execution. |
java.util.Properties |
getProperties(java.io.File propertyFile)
Load a properties file. |
java.util.Properties |
getProperties(Resource propertyResource)
Load a properties resource. |
void |
setDir(java.io.File dir)
The base directory to use when replacing a token in multiple files; required if file is not defined. |
void |
setEncoding(java.lang.String encoding)
Set the file encoding to use on the files read and written by the task; optional, defaults to default JVM encoding. |
void |
setFailOnNoReplacements(boolean b)
Whether the build should fail if nothing has been replaced. |
void |
setFile(java.io.File file)
Set the source file; required unless dir is set. |
void |
setPreserveLastModified(boolean b)
Whether the file timestamp shall be preserved even if the file is modified. |
void |
setPropertyFile(java.io.File propertyFile)
The name of a property file from which properties specified using nested <replacefilter> elements are drawn; required only if
the property attribute of <replacefilter> is used. |
void |
setPropertyResource(Resource propertyResource)
A resource from which properties specified using nested <replacefilter> elements are drawn; required
only if the property attribute of
<replacefilter> is used. |
void |
setReplaceFilterFile(java.io.File replaceFilterFile)
Sets the name of a property file containing filters; optional. |
void |
setReplaceFilterResource(Resource replaceFilter)
Sets the name of a resource 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(java.lang.String token)
Set the string token to replace; required unless a nested replacetoken element or the
replacefilterresource attribute is used. |
void |
setValue(java.lang.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. |
| Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
|---|
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, XsetIgnore, XsetItems |
| Methods inherited from class org.apache.tools.ant.Task |
|---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
|---|
clone, getDescription, getLocation, getProject, setDescription, setLocation |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Replace()
| Method Detail |
|---|
public void execute()
throws BuildException
execute in class TaskBuildException - if we cant build
public void validateAttributes()
throws BuildException
BuildException - if any supplied attribute is invalid or any
mandatory attribute is missing.
public void validateReplacefilters()
throws BuildException
BuildException - if any supplied attribute is invalid or any
mandatory attribute is missing.
public java.util.Properties getProperties(java.io.File propertyFile)
throws BuildException
propertyFile - the file to load the properties from.
Properties object.
BuildException - if the file could not be found or read.
public java.util.Properties getProperties(Resource propertyResource)
throws BuildException
propertyResource - the resource to load the properties from.
Properties object.
BuildException - if the resource could not be found or read.public void setFile(java.io.File file)
dir is set.
file - source File.public void setSummary(boolean summary)
false.
summary - boolean whether a summary of the
replace operation should be logged.public void setReplaceFilterFile(java.io.File replaceFilterFile)
replaceFilterFile - File to load.public void setReplaceFilterResource(Resource replaceFilter)
replaceFilter - Resource to load.public void setDir(java.io.File dir)
file is not defined.
dir - File representing the base directory.public void setToken(java.lang.String token)
replacetoken element or the
replacefilterresource attribute is used.
token - token String.public void setValue(java.lang.String value)
value - replacement value.public void setEncoding(java.lang.String encoding)
encoding - the encoding to use on the files.public Replace.NestedString createReplaceToken()
NestedString to configure.public Replace.NestedString createReplaceValue()
NestedString to configure.public void setPropertyFile(java.io.File propertyFile)
<replacefilter> elements are drawn; required only if
the property attribute of <replacefilter> is used.
propertyFile - File to load.public void setPropertyResource(Resource propertyResource)
<replacefilter> elements are drawn; required
only if the property attribute of
<replacefilter> is used.
propertyResource - Resource to load.public Replace.Replacefilter createReplacefilter()
Replacefilter object to be configured.public void addConfigured(ResourceCollection rc)
public void setPreserveLastModified(boolean b)
public void setFailOnNoReplacements(boolean b)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||