public final class HeadFilter extends BaseParamFilterReader implements ChainableReader
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>
Constructor and Description |
---|
HeadFilter()
Constructor for "dummy" instances.
|
HeadFilter(java.io.Reader in)
Creates a new filtered reader.
|
Modifier and Type | Method and Description |
---|---|
java.io.Reader |
chain(java.io.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.
|
getParameters, setParameters
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
public HeadFilter()
BaseFilterReader()
public HeadFilter(java.io.Reader in)
in
- A Reader object providing the underlying stream.
Must not be null
.public int read() throws java.io.IOException
read
in class java.io.FilterReader
java.io.IOException
- if the underlying stream throws an IOException
during readingpublic void setLines(long lines)
lines
- the number of lines to be returned in the filtered streampublic void setSkip(long skip)
skip
- the number of lines to be skipped in the filtered streampublic java.io.Reader chain(java.io.Reader rdr)
chain
in interface ChainableReader
rdr
- A Reader object providing the underlying stream.
Must not be null
.