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 SummaryNested Classes
- 
Field SummaryFields inherited from class java.io.FilterReaderin
- 
Constructor SummaryConstructorsConstructorDescriptionConstructor for "dummy" instances.ReplaceTokens(Reader in) Creates a new filtered reader.
- 
Method SummaryModifier 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.BaseParamFilterReadergetParameters, setParametersMethods inherited from class org.apache.tools.ant.filters.BaseFilterReadergetInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skipMethods inherited from class java.io.FilterReaderclose, mark, markSupported, ready, resetMethods inherited from class java.io.ReadernullReader, read, read, transferTo
- 
Constructor Details- 
ReplaceTokenspublic ReplaceTokens()Constructor for "dummy" instances.- See Also:
 
- 
ReplaceTokensCreates a new filtered reader.- Parameters:
- in- A Reader object providing the underlying stream. Must not be- null.
 
 
- 
- 
Method Details- 
readReturns the next character in the filtered stream, replacing tokens from the original stream.- Overrides:
- readin class- FilterReader
- 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
 
- 
setBeginTokenSets the "begin token" character.- Parameters:
- beginToken- the character used to denote the beginning of a token
 
- 
setEndTokenSets the "end token" character.- Parameters:
- endToken- the character used to denote the end of a token
 
- 
setPropertiesResourceA resource containing properties, each of which is interpreted as a token/value pair.- Parameters:
- r- Resource
- Since:
- Ant 1.8.0
 
- 
addConfiguredTokenAdds 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.
 
- 
chainCreates a new ReplaceTokens using the passed in Reader for instantiation.- Specified by:
- chainin interface- ChainableReader
- 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
 
 
-