org.apache.tools.ant.filters

Class SuffixLines

public final class SuffixLines extends BaseParamFilterReader implements ChainableReader

Attaches a suffix to every line. Example:
<suffixlines suffix="Foo"/>
Or:
<filterreader classname="org.apache.tools.ant.filters.SuffixLines">
  <param name="suffix" value="Foo"/>
 </filterreader>

Since: Ant 1.8.0

Constructor Summary
SuffixLines()
Constructor for "dummy" instances.
SuffixLines(Reader in)
Creates a new filtered reader.
Method Summary
Readerchain(Reader rdr)
Creates a new SuffixLines filter using the passed in Reader for instantiation.
intread()
Returns the next character in the filtered stream.
voidsetSuffix(String suffix)
Sets the suffix to add at the end of each input line.

Constructor Detail

SuffixLines

public SuffixLines()
Constructor for "dummy" instances.

See Also: BaseFilterReader

SuffixLines

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

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

Method Detail

chain

public Reader chain(Reader rdr)
Creates a new SuffixLines filter 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 int read()
Returns the next character in the filtered stream. One line is read from the original input, and the suffix added. The resulting line is then used until it ends, at which point the next original line is read, etc.

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

setSuffix

public void setSuffix(String suffix)
Sets the suffix to add at the end of each input line.

Parameters: suffix The suffix to add at the end of each input line. May be null, in which case no suffix is added.