Package org.apache.tools.ant.filters
Class HeadFilter
- 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.HeadFilter
 
 
 
 
 
- 
- All Implemented Interfaces:
- java.io.Closeable,- java.lang.AutoCloseable,- java.lang.Readable,- ChainableReader,- Parameterizable
 
 public final class HeadFilter extends BaseParamFilterReader implements ChainableReader Reads the firstnlines of a stream. (Default is first 10 lines.)Example: <headfilter lines="3"/> Or:<filterreader classname="org.apache.tools.ant.filters.HeadFilter"> <param name="lines" value="3"/> </filterreader>
- 
- 
Constructor SummaryConstructors Constructor Description HeadFilter()Constructor for "dummy" instances.HeadFilter(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 HeadFilter using the passed in Reader for instantiation.intread()Returns the next character in the filtered stream.voidsetLines(long lines)Sets the number of lines to be returned in the filtered stream.voidsetSkip(long skip)Sets the number of lines to be skipped in the filtered stream.- 
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- 
HeadFilterpublic HeadFilter() Constructor for "dummy" instances.- See Also:
- BaseFilterReader()
 
 - 
HeadFilterpublic HeadFilter(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. If the desired number of lines have already been read, the resulting stream is effectively at an end. Otherwise, the next character from the underlying stream is read and returned.- 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
 
 - 
setLinespublic void setLines(long lines) Sets the number of lines to be returned in the filtered stream.- Parameters:
- lines- the number of lines to be returned in the filtered stream
 
 - 
setSkippublic void setSkip(long skip) Sets the number of lines to be skipped in the filtered stream.- Parameters:
- skip- the number of lines to be skipped in the filtered stream
 
 - 
chainpublic java.io.Reader chain(java.io.Reader rdr) Creates a new HeadFilter 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
 
 
- 
 
-