java.io.Closeable
, java.lang.AutoCloseable
, java.lang.Readable
, ChainableReader
, Parameterizable
public final class ReplaceTokens extends BaseParamFilterReader implements ChainableReader
<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>
Modifier and Type | Class | Description |
---|---|---|
static class |
ReplaceTokens.Token |
Holds a token
|
Constructor | Description |
---|---|
ReplaceTokens() |
Constructor for "dummy" instances.
|
ReplaceTokens(java.io.Reader in) |
Creates a new filtered reader.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addConfiguredToken(ReplaceTokens.Token token) |
Adds a token element to the map of tokens to replace.
|
java.io.Reader |
chain(java.io.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(java.lang.String beginToken) |
Sets the "begin token" character.
|
void |
setEndToken(java.lang.String endToken) |
Sets the "end token" character.
|
void |
setPropertiesResource(Resource r) |
A resource containing properties, each of which is interpreted
as a token/value pair.
|
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
getParameters, setParameters
public ReplaceTokens()
BaseFilterReader()
public ReplaceTokens(java.io.Reader in)
in
- A Reader object providing the underlying stream.
Must not be null
.public int read() throws java.io.IOException
read
in class java.io.FilterReader
java.io.IOException
- if the underlying stream throws an IOException
during readingpublic void setBeginToken(java.lang.String beginToken)
beginToken
- the character used to denote the beginning of a tokenpublic void setEndToken(java.lang.String endToken)
endToken
- the character used to denote the end of a tokenpublic void setPropertiesResource(Resource r)
r
- Resourcepublic void addConfiguredToken(ReplaceTokens.Token token)
token
- The token to add to the map of replacements.
Must not be null
.public java.io.Reader chain(java.io.Reader rdr)
chain
in interface ChainableReader
rdr
- A Reader object providing the underlying stream.
Must not be null
.