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> 
- 
- 
Constructor SummaryConstructors Constructor Description PrefixLines()Constructor for "dummy" instances.PrefixLines(java.io.Reader in)Creates a new filtered reader.
 - 
Method SummaryModifier and Type Method Description java.io.Readerchain(java.io.Reader rdr)Creates a new PrefixLines filter using the passed in Reader for instantiation.intread()Returns the next character in the filtered stream.voidsetPrefix(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.BaseParamFilterReadergetParameters, setParameters
 - 
Methods inherited from class org.apache.tools.ant.filters.BaseFilterReadergetInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
 
- 
 
- 
- 
- 
Constructor Detail- 
PrefixLinespublic PrefixLines() Constructor for "dummy" instances.- See Also:
- BaseFilterReader()
 
 - 
PrefixLinespublic PrefixLines(java.io.Reader in) Creates a new filtered reader.- Parameters:
- in- A Reader object providing the underlying stream. Must not be- null.
 
 
- 
 - 
Method Detail- 
readpublic 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:
- readin class- java.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
 
 - 
setPrefixpublic 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 be- null, in which case no prefix is added.
 
 - 
chainpublic java.io.Reader chain(java.io.Reader rdr) Creates a new PrefixLines filter 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
 
 
- 
 
-