java.io
Class FilterReader
- Closeable, Readable
This is the common superclass of all standard classes that filter
input. It acts as a layer on top of an underlying
Reader
and simply redirects calls made to it to the subordinate Reader
instead. Subclasses of this class perform additional filtering
functions in addition to simply redirecting the call.
When creating a subclass of
FilterReader, override the
appropriate methods to implement the desired filtering. However, note
that the
read(char[]) method does not need to be overridden
as this class redirects calls to that method to
read(yte[], int, int) instead of to the subordinate
Reader} read(yte[]) method.
protected Reader | in- This is the subordinate
Reader to which method calls
are redirected
|
void | close()- This method closes the stream by calling the
close() method
of the underlying stream.
|
void | mark(int readlimit)- Calls the
in.mark(int) method.
|
boolean | markSupported()- Calls the
in.markSupported() method.
|
int | read()- Calls the
in.read() method
|
int | read(char[] buf, int offset, int len)- Calls the
in.read(char[], int, int) method.
|
boolean | ready()- Calls the
in.read() method.
|
void | reset()- Calls the
in.reset() method.
|
long | skip(long num_chars)- Calls the
in.skip(long) method
|
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
in
protected Reader in
This is the subordinate Reader to which method calls
are redirected
FilterReader
protected FilterReader(Reader in)
Create a FilterReader with the specified subordinate
Reader.
The lock of the new FilterReader will be set
to in.lock.
in - The subordinate Reader
mark
public void mark(int readlimit)
throws IOException Calls the in.mark(int) method.
- mark in interface Reader
readlimit - The parameter passed to in.mark(int)
markSupported
public boolean markSupported()
Calls the in.markSupported() method.
- markSupported in interface Reader
true if mark/reset is supported,
false otherwise
read
public int read()
throws IOException Calls the in.read() method
- read in interface Reader
- The value returned from
in.read()
read
public int read(char[] buf,
int offset,
int len)
throws IOException Calls the in.read(char[], int, int) method.
buf - The buffer to read chars intooffset - The index into the buffer to start storing charslen - The maximum number of chars to read.
- The value retured from
in.read(char[], int, int)
ready
public boolean ready()
throws IOException Calls the in.read() method.
- ready in interface Reader
- The value returned from
in.available()
skip
public long skip(long num_chars)
throws IOException Calls the in.skip(long) method
- skip in interface Reader
num_chars - The requested number of chars to skip.
- The value returned from
in.skip(long)
FilterReader.java -- Base class for char stream classes that filter input
Copyright (C) 1998, 1999, 2001, 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.