| org.apache.tools.ant.filters.BaseFilterReader org.apache.tools.ant.filters.BaseParamFilterReader org.apache.tools.ant.filters.HeadFilter
HeadFilter | final public class HeadFilter extends BaseParamFilterReader implements ChainableReader(Code) | | 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>
|
Constructor Summary | |
public | HeadFilter() Constructor for "dummy" instances. | public | HeadFilter(Reader in) Creates a new filtered reader. |
Method Summary | |
public Reader | chain(Reader rdr) Creates a new HeadFilter using the passed in
Reader for instantiation.
Parameters: rdr - A Reader object providing the underlying stream.Must not be null . | public int | read() Returns the next character in the filtered stream. | public void | setLines(long lines) Sets the number of lines to be returned in the filtered stream. | public void | setSkip(long skip) Sets the number of lines to be skipped in the filtered stream. |
HeadFilter | public HeadFilter(Reader in)(Code) | | Creates a new filtered reader.
Parameters: in - A Reader object providing the underlying stream.Must not be null . |
chain | public Reader chain(Reader rdr)(Code) | | Creates a new HeadFilter using the passed in
Reader for instantiation.
Parameters: rdr - A Reader object providing the underlying stream.Must not be null . a new filter based on this configuration, but filteringthe specified reader |
read | public int read() throws IOException(Code) | | 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 -1if the end of the resulting stream has been reached exception: IOException - if the underlying stream throws an IOExceptionduring reading |
setLines | public void setLines(long lines)(Code) | | 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 |
setSkip | public void setSkip(long skip)(Code) | | 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 |
|
|