| java.lang.Object
 java.io.Reader
java.io.FilterReader
org.apache.tools.ant.filters.BaseFilterReader
All known Subclasses: org.apache.tools.ant.filters.ClassConstants, org.apache.tools.ant.filters.BaseParamFilterReader, org.apache.tools.ant.filters.ExpandProperties, org.apache.tools.ant.filters.StripJavaComments, org.apache.tools.ant.filters.TokenFilter,
| BaseFilterReader | | abstract public class BaseFilterReader extends FilterReader (Code) | | Base class for core filter readers.
|
| Constructor Summary | |
| public | BaseFilterReader()
Constructor used by Ant's introspection mechanism.
The original filter reader is only used for chaining
purposes, never for filtering purposes (and indeed
it would be useless for filtering purposes, as it has
no real data to filter). | | public | BaseFilterReader(Reader in)
Creates a new filtered reader. |
| Method Summary | |
| final protected boolean | getInitialized()
Returns the initialized status. | | final protected Project | getProject()
Returns the project this filter is part of. | | final public int | read(char[] cbuf, int off, int len)
Reads characters into a portion of an array. | | final protected String | readFully()
Reads to the end of the stream, returning the contents as a String. | | final protected String | readLine()
Reads a line of text ending with '\n' (or until the end of the stream). | | final protected void | setInitialized(boolean initialized)
Sets the initialized status. | | final public void | setProject(Project project)
Sets the project to work with. | | final public long | skip(long n)
Skips characters. |
| BaseFilterReader | | public BaseFilterReader()(Code) | | Constructor used by Ant's introspection mechanism.
The original filter reader is only used for chaining
purposes, never for filtering purposes (and indeed
it would be useless for filtering purposes, as it has
no real data to filter). ChainedReaderHelper uses
this placeholder instance to create a chain of real filters.
|
| BaseFilterReader | | public BaseFilterReader(Reader in)(Code) | | Creates a new filtered reader.
Parameters:
in - A Reader object providing the underlying stream.Must not be null. |
| getInitialized | | final protected boolean getInitialized()(Code) | | Returns the initialized status.
whether or not the filter is initialized |
| getProject | | final protected Project getProject()(Code) | | Returns the project this filter is part of.
the project this filter is part of |
| read | | final public int read(char[] cbuf, int off, int len) throws IOException(Code) | | Reads characters into a portion of an array. This method will block
until some input is available, an I/O error occurs, or the end of the
stream is reached.
Parameters:
cbuf - Destination buffer to write characters to.Must not be null.
Parameters:
off - Offset at which to start storing characters.
Parameters:
len - Maximum number of characters to read. the number of characters read, or -1 if the end of thestream has been reached
exception:
IOException - If an I/O error occurs |
| readFully | | final protected String readFully() throws IOException(Code) | | Reads to the end of the stream, returning the contents as a String.
the remaining contents of the reader, as a String
exception:
IOException - if the underlying reader throws one duringreading |
| readLine | | final protected String readLine() throws IOException(Code) | | Reads a line of text ending with '\n' (or until the end of the stream).
The returned String retains the '\n'.
the line read, or null if the end of the streamhas already been reached
exception:
IOException - if the underlying reader throws one duringreading |
| setInitialized | | final protected void setInitialized(boolean initialized)(Code) | | Sets the initialized status.
Parameters:
initialized - Whether or not the filter is initialized. |
| setProject | | final public void setProject(Project project)(Code) | | Sets the project to work with.
Parameters:
project - The project this filter is part of.Should not be null. |
| skip | | final public long skip(long n) throws IOException, IllegalArgumentException(Code) | | Skips characters. This method will block until some characters are
available, an I/O error occurs, or the end of the stream is reached.
Parameters:
n - The number of characters to skip the number of characters actually skipped
exception:
IllegalArgumentException - If n is negative.
exception:
IOException - If an I/O error occurs |
|
|