org.apache.tools.ant.filters
Class ReplaceTokens
- ChainableReader, Parameterizable
public final class ReplaceTokens
Replaces tokens in the original input with user-supplied values.
Example:
<replacetokens begintoken="#" endtoken="#">
<token key="DATE" value="${TODAY}"/>
</replacetokens>
Or:
<filterreader classname="org.apache.tools.ant.filters.ReplaceTokens">
<param type="tokenchar" name="begintoken" value="#"/>
<param type="tokenchar" name="endtoken" value="#"/>
<param type="token" name="DATE" value="${TODAY}"/>
</filterreader>
void | addConfiguredToken(ReplaceTokens.Token token) - Adds a token element to the map of tokens to replace.
|
Reader | chain(Reader rdr) - Creates a new ReplaceTokens using the passed in
Reader for instantiation.
|
int | read() - Returns the next character in the filtered stream, replacing tokens
from the original stream.
|
void | setBeginToken(char beginToken) - Sets the "begin token" character.
|
void | setEndToken(char endToken) - Sets the "end token" character.
|
ReplaceTokens
public ReplaceTokens()
Constructor for "dummy" instances.
ReplaceTokens
public ReplaceTokens(Reader in)
Creates a new filtered reader.
in
- A Reader object providing the underlying stream.
Must not be null
.
addConfiguredToken
public void addConfiguredToken(ReplaceTokens.Token token)
Adds a token element to the map of tokens to replace.
token
- The token to add to the map of replacements.
Must not be null
.
chain
public Reader chain(Reader rdr)
Creates a new ReplaceTokens using the passed in
Reader for instantiation.
- chain in interface ChainableReader
rdr
- A Reader object providing the underlying stream.
Must not be null
.
- a new filter based on this configuration, but filtering
the specified reader
read
public int read()
throws IOException
Returns the next character in the filtered stream, replacing tokens
from the original stream.
- the next character in the resulting stream, or -1
if the end of the resulting stream has been reached
setBeginToken
public void setBeginToken(char beginToken)
Sets the "begin token" character.
beginToken
- the character used to denote the beginning of a token
setEndToken
public void setEndToken(char endToken)
Sets the "end token" character.
endToken
- the character used to denote the end of a token