org.apache.tools.ant.filters
Class HeadFilter
- ChainableReader, Parameterizable
public final class HeadFilter
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>
Reader | chain(Reader rdr) - Creates a new HeadFilter using the passed in
Reader for instantiation.
|
int | read() - Returns the next character in the filtered stream.
|
void | setLines(long lines) - Sets the number of lines to be returned in the filtered stream.
|
void | setSkip(long skip) - Sets the number of lines to be skipped in the filtered stream.
|
HeadFilter
public HeadFilter()
Constructor for "dummy" instances.
HeadFilter
public HeadFilter(Reader in)
Creates a new filtered reader.
in
- A Reader object providing the underlying stream.
Must not be null
.
chain
public final Reader chain(Reader rdr)
Creates a new HeadFilter using the passed in
Reader for instantiation.
- chain in interface ChainableReader
rdr
- A Reader object providing the underlying stream.
Must not be null
.
- 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. 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.
- the next character in the resulting stream, or -1
if the end of the resulting stream has been reached
setLines
public final void setLines(long lines)
Sets the number of lines to be returned in the filtered stream.
lines
- the number of lines to be returned in the filtered stream
setSkip
public final void setSkip(long skip)
Sets the number of lines to be skipped in the filtered stream.
skip
- the number of lines to be skipped in the filtered stream
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.