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:
- Closeable,- AutoCloseable,- Readable,- ChainableReader,- Parameterizable
Reads the first 
n lines 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>- 
Field SummaryFields inherited from class java.io.FilterReaderin
- 
Constructor SummaryConstructorsConstructorDescriptionConstructor for "dummy" instances.HeadFilter(Reader in) Creates a new filtered reader.
- 
Method SummaryModifier and TypeMethodDescriptionCreates 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, setParametersMethods inherited from class org.apache.tools.ant.filters.BaseFilterReadergetInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skipMethods inherited from class java.io.FilterReaderclose, mark, markSupported, ready, resetMethods inherited from class java.io.ReadernullReader, read, read, transferTo
- 
Constructor Details- 
HeadFilterpublic HeadFilter()Constructor for "dummy" instances.- See Also:
 
- 
HeadFilterCreates a new filtered reader.- Parameters:
- in- A Reader object providing the underlying stream. Must not be- null.
 
 
- 
- 
Method Details- 
readReturns 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- FilterReader
- 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
 
- 
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
 
- 
chainCreates 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
 
 
-