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.
- *
- * @author Aaron M. Renn (arenn@urbanophile.com)
- * @author Warren Levy Reader to which method calls
- * are redirected
- */
-protected Reader in;
-
-/*************************************************************************/
-
-/*
- * Constructors
- */
-
-/**
- * Create a FilterReader with the specified subordinate
- * Reader.
- * The lock of the new FilterReader will be set
- * to in.lock.
- *
- * @param in The subordinate Reader
- */
-protected
-FilterReader(Reader in)
-{
- super(in.lock);
- this.in = in;
-}
-
-/*************************************************************************/
-
-/*
- * Instance Methods
- */
-
-/**
- * Calls the in.mark(int) method.
- *
- * @param readlimit The parameter passed to in.mark(int)
- *
- * @exception IOException If an error occurs
- */
-public void
-mark(int readlimit) throws IOException
-{
- in.mark(readlimit);
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.markSupported() method.
- *
- * @return true if mark/reset is supported, false otherwise
- */
-public boolean
-markSupported()
-{
- return(in.markSupported());
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.reset() method.
- *
- * @exception IOException If an error occurs
- */
-public void
-reset() throws IOException
-{
- in.reset();
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.read() method.
- *
- * @return The value returned from in.available()
- *
- * @exception IOException If an error occurs
- */
-public boolean
-ready() throws IOException
-{
- return(in.ready());
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.skip(long) method
- *
- * @param The requested number of chars to skip.
- *
- * @return The value returned from in.skip(long)
- *
- * @exception IOException If an error occurs
- */
-public long
-skip(long num_chars) throws IOException
-{
- return(in.skip(num_chars));
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.read() method
- *
- * @return The value returned from in.read()
- *
- * @exception IOException If an error occurs
- */
-public int
-read() throws IOException
-{
- return(in.read());
-}
-
-/*************************************************************************/
-
-/**
- * Calls the in.read(char[], int, int) method.
- *
- * @param buf The buffer to read chars into
- * @param offset The index into the buffer to start storing chars
- * @param len The maximum number of chars to read.
- *
- * @return The value retured from in.read(char[], int, int)
- *
- * @exception IOException If an error occurs
- */
-public int
-read(char[] buf, int offset, int len) throws IOException
-{
- return(in.read(buf, offset, len));
-}
-
-/*************************************************************************/
-
-/**
- * This method closes the stream by calling the close() method
- * of the underlying stream.
- *
- * @exception IOException If an error occurs
- */
-public void
-close() throws IOException
-{
- in.close();
-}
-
-} // class FilterReader