Package org.apache.tools.ant.filters
Class ReplaceTokens
java.lang.Object
java.io.Reader
java.io.FilterReader
org.apache.tools.ant.filters.BaseFilterReader
org.apache.tools.ant.filters.BaseParamFilterReader
org.apache.tools.ant.filters.ReplaceTokens
- All Implemented Interfaces:
Closeable,AutoCloseable,Readable,ChainableReader,Parameterizable
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
Nested Classes -
Field Summary
Fields inherited from class java.io.FilterReader
in -
Constructor Summary
ConstructorsConstructorDescriptionConstructor for "dummy" instances.ReplaceTokens(Reader in) Creates a new filtered reader. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a token element to the map of tokens to replace.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(String beginToken) Sets the "begin token" character.voidsetEndToken(String endToken) Sets the "end token" character.voidA resource containing properties, each of which is interpreted as a token/value pair.Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
getParameters, setParametersMethods inherited from class org.apache.tools.ant.filters.BaseFilterReader
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skipMethods inherited from class java.io.FilterReader
close, mark, markSupported, ready, resetMethods inherited from class java.io.Reader
nullReader, read, read, transferTo
-
Constructor Details
-
ReplaceTokens
public ReplaceTokens()Constructor for "dummy" instances.- See Also:
-
ReplaceTokens
Creates a new filtered reader.- Parameters:
in- A Reader object providing the underlying stream. Must not benull.
-
-
Method Details
-
read
Returns the next character in the filtered stream, replacing tokens from the original stream.- Overrides:
readin classFilterReader- 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
Sets the "begin token" character.- Parameters:
beginToken- the character used to denote the beginning of a token
-
setEndToken
Sets the "end token" character.- Parameters:
endToken- the character used to denote the end of a token
-
setPropertiesResource
A resource containing properties, each of which is interpreted as a token/value pair.- Parameters:
r- Resource- Since:
- Ant 1.8.0
-
addConfiguredToken
Adds a token element to the map of tokens to replace.- Parameters:
token- The token to add to the map of replacements. Must not benull.
-
chain
Creates a new ReplaceTokens using the passed in Reader for instantiation.- Specified by:
chainin interfaceChainableReader- Parameters:
rdr- A Reader object providing the underlying stream. Must not benull.- Returns:
- a new filter based on this configuration, but filtering the specified reader
-