Package org.apache.tools.ant.filters
Class PrefixLines
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.PrefixLines
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Readable
,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>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PrefixLines()
Constructor for "dummy" instances.PrefixLines(java.io.Reader in)
Creates a new filtered reader. -
Method Summary
Modifier and Type Method Description java.io.Reader
chain(java.io.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(java.lang.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()
-
PrefixLines
public PrefixLines(java.io.Reader in)Creates a new filtered reader.- Parameters:
in
- A Reader object providing the underlying stream. Must not benull
.
-
-
Method Details
-
read
public int read() throws java.io.IOExceptionReturns 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.- Overrides:
read
in classjava.io.FilterReader
- Returns:
- the next character in the resulting stream, or -1 if the end of the resulting stream has been reached
- Throws:
java.io.IOException
- if the underlying stream throws an IOException during reading
-
setPrefix
public void setPrefix(java.lang.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 benull
, in which case no prefix is added.
-
chain
public java.io.Reader chain(java.io.Reader rdr)Creates a new PrefixLines filter using the passed in Reader for instantiation.- Specified by:
chain
in interfaceChainableReader
- Parameters:
rdr
- A Reader object providing the underlying stream. Must not benull
.- Returns:
- a new filter based on this configuration, but filtering the specified reader
-