org.apache.tools.ant.filters

Class PrefixLines

Implemented Interfaces:
ChainableReader, Parameterizable

public final class PrefixLines
extends BaseParamFilterReader
implements ChainableReader

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

Constructor Summary

PrefixLines()
Constructor for "dummy" instances.
PrefixLines(Reader in)
Creates a new filtered reader.

Method Summary

Reader
chain(Reader rdr)
Creates a new PrefixLines filter using the passed in Reader for instantiation.
int
read()
Returns the next character in the filtered stream.
void
setPrefix(String prefix)
Sets the prefix to add at the start of each input line.

Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader

getParameters, setParameters

Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader

getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip

Constructor Details

PrefixLines

public PrefixLines()
Constructor for "dummy" instances.

See Also:
BaseFilterReader.BaseFilterReader()


PrefixLines

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

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

Method Details

chain

public final Reader chain(Reader rdr)
Creates a new PrefixLines filter using the passed in Reader for instantiation.
Specified by:
chain in 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


read

public final int read()
            throws IOException
Returns the next character in the filtered stream. One line is read from the original input, and the prefix 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


setPrefix

public final void setPrefix(String prefix)
Sets the prefix to add at the start of each input line.

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


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.