Class ReplaceTokens

All Implemented Interfaces:
Closeable, AutoCloseable, Readable, ChainableReader, Parameterizable

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}"/>
<filterreader classname="">
   <param type="tokenchar" name="begintoken" value="#"/>
   <param type="tokenchar" name="endtoken" value="#"/>
   <param type="token" name="DATE" value="${TODAY}"/>
  • Constructor Details

    • ReplaceTokens

      public ReplaceTokens()
      Constructor for "dummy" instances.
      See Also:
    • ReplaceTokens

      public ReplaceTokens(Reader in)
      Creates a new filtered reader.
      in - A Reader object providing the underlying stream. Must not be null.
  • Method Details

    • read

      public int read() throws IOException
      Returns the next character in the filtered stream, replacing tokens from the original stream.
      read in class FilterReader
      the next character in the resulting stream, or -1 if the end of the resulting stream has been reached
      IOException - if the underlying stream throws an IOException during reading
    • setBeginToken

      public void setBeginToken(String beginToken)
      Sets the "begin token" character.
      beginToken - the character used to denote the beginning of a token
    • setEndToken

      public void setEndToken(String endToken)
      Sets the "end token" character.
      endToken - the character used to denote the end of a token
    • setPropertiesResource

      public void setPropertiesResource(Resource r)
      A resource containing properties, each of which is interpreted as a token/value pair.
      r - Resource
      Ant 1.8.0
    • 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.
      Specified by:
      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