|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.io.Reader
java.io.FilterReader
org.apache.tools.ant.filters.BaseFilterReader
org.apache.tools.ant.filters.BaseParamFilterReader
org.apache.tools.ant.filters.HeadFilter
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>
| Field Summary |
|---|
| Fields inherited from class java.io.FilterReader |
|---|
in |
| Fields inherited from class java.io.Reader |
|---|
lock |
| Constructor Summary | |
|---|---|
HeadFilter()
Constructor for "dummy" instances. |
|
HeadFilter(java.io.Reader in)
Creates a new filtered reader. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader |
|---|
getParameters, setParameters |
| Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader |
|---|
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip |
| Methods inherited from class java.io.FilterReader |
|---|
close, mark, markSupported, ready, reset |
| Methods inherited from class java.io.Reader |
|---|
read, read |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public HeadFilter()
BaseFilterReader.BaseFilterReader()public HeadFilter(java.io.Reader in)
in - A Reader object providing the underlying stream.
Must not be null.| Method Detail |
|---|
public int read()
throws java.io.IOException
read in class java.io.FilterReaderjava.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 ChainableReaderrdr - A Reader object providing the underlying stream.
Must not be null.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||