org.apache.tools.ant.taskdefs

Class Replace.Replacefilter

public class Replace.Replacefilter extends Object

A filter to apply.
Method Summary
Replace.NestedStringcreateReplaceToken()
Create a token to filter as the text of a nested element.
Replace.NestedStringcreateReplaceValue()
Create a string to replace the token as the text of a nested element.
StringgetProperty()
Get the name of the property whose value is to serve as the replacement value.
StringgetReplaceValue()
Get the replacement value for this filter token.
StringgetToken()
Get the string to search for.
StringgetValue()
Get replacement String.
voidsetProperty(String property)
Set the name of the property whose value is to serve as the replacement value; required if value is not set.
voidsetToken(String t)
Set the token to replace.
voidsetValue(String value)
The replacement string; required if property is not set.
voidvalidate()
Validate the filter's configuration.

Method Detail

createReplaceToken

public Replace.NestedString createReplaceToken()
Create a token to filter as the text of a nested element.

Returns: nested token NestedString to configure.

Since: Ant 1.8.0

createReplaceValue

public Replace.NestedString createReplaceValue()
Create a string to replace the token as the text of a nested element.

Returns: replacement value NestedString to configure.

Since: Ant 1.8.0

getProperty

public String getProperty()
Get the name of the property whose value is to serve as the replacement value.

Returns: property or null.

getReplaceValue

public String getReplaceValue()
Get the replacement value for this filter token.

Returns: the replacement value

getToken

public String getToken()
Get the string to search for.

Returns: current String token.

getValue

public String getValue()
Get replacement String.

Returns: replacement or null.

setProperty

public void setProperty(String property)
Set the name of the property whose value is to serve as the replacement value; required if value is not set.

Parameters: property property name.

setToken

public void setToken(String t)
Set the token to replace.

Parameters: t String token.

setValue

public void setValue(String value)
The replacement string; required if property is not set.

Parameters: value String value to replace.

validate

public void validate()
Validate the filter's configuration.

Throws: BuildException if any part is invalid.