org.apache.tools.ant.filters

Class ReplaceTokens

public final class ReplaceTokens extends BaseParamFilterReader implements ChainableReader

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>
Nested Class Summary
static classReplaceTokens.Token
Holds a token
Constructor Summary
ReplaceTokens()
Constructor for "dummy" instances.
ReplaceTokens(Reader in)
Creates a new filtered reader.
Method Summary
voidaddConfiguredToken(ReplaceTokens.Token token)
Adds a token element to the map of tokens to replace.
Readerchain(Reader rdr)
Creates a new ReplaceTokens using the passed in Reader for instantiation.
intread()
Returns the next character in the filtered stream, replacing tokens from the original stream.
voidsetBeginToken(char beginToken)
Sets the "begin token" character.
voidsetEndToken(char endToken)
Sets the "end token" character.

Constructor Detail

ReplaceTokens

public ReplaceTokens()
Constructor for "dummy" instances.

See Also: BaseFilterReader

ReplaceTokens

public ReplaceTokens(Reader in)
Creates a new filtered reader.

Parameters: in A Reader object providing the underlying stream. Must not be null.

Method Detail

addConfiguredToken

public final void addConfiguredToken(ReplaceTokens.Token token)
Adds a token element to the map of tokens to replace.

Parameters: token The token to add to the map of replacements. Must not be null.

chain

public final Reader chain(Reader rdr)
Creates a new ReplaceTokens using the passed in Reader for instantiation.

Parameters: rdr A Reader object providing the underlying stream. Must not be null.

Returns: a new filter based on this configuration, but filtering the specified reader

read

public final int read()
Returns the next character in the filtered stream, replacing tokens from the original stream.

Returns: the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Throws: IOException if the underlying stream throws an IOException during reading

setBeginToken

public final void setBeginToken(char beginToken)
Sets the "begin token" character.

Parameters: beginToken the character used to denote the beginning of a token

setEndToken

public final void setEndToken(char endToken)
Sets the "end token" character.

Parameters: endToken the character used to denote the end of a token

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.