From 477946a63dee474c725243ae0d998f4cba1bfc0a Mon Sep 17 00:00:00 2001 From: Mark Wielaard Date: Mon, 1 Oct 2001 18:24:54 +0000 Subject: FileWriter.java: Merge with Classpath. * java/io/FileWriter.java: Merge with Classpath. * java/io/FilterInputStream.java: Ditto. (mark): no longer synchronized (reset): Likewise * java/io/FilterOutputStream.java: Merge with Classpath. * java/io/FilterReader.java: Ditto. (mark): no longer synchronized (reset): Likewise * java/io/FilterWriter.java: Merge with Classpath. * java/io/Writer.java: Ditto. * java/lang/Compiler.java: Ditto. * java/lang/Process.java: Ditto. * java/lang/Void.java: Ditto. * java/net/ContentHandler.java: Ditto. * java/net/DatagramPacket.java: Ditto. * java/net/MulticastSocket.java: Merge comments with Classpath. From-SVN: r45930 --- libjava/java/io/FilterReader.java | 263 +++++++++++++++++++++++++++++--------- 1 file changed, 201 insertions(+), 62 deletions(-) (limited to 'libjava/java/io/FilterReader.java') diff --git a/libjava/java/io/FilterReader.java b/libjava/java/io/FilterReader.java index 608f910ccbd..a3897bcbdf0 100644 --- a/libjava/java/io/FilterReader.java +++ b/libjava/java/io/FilterReader.java @@ -1,75 +1,214 @@ -/* Copyright (C) 1998, 1999, 2001 Free Software Foundation +/* FilterReader.java -- Base class for char stream classes that filter input + Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc. - This file is part of libgcj. +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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ package java.io; -/** - * @author Warren Levy - * @date October 15, 1998. - */ /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3 * "The Java Language Specification", ISBN 0-201-63451-1 * plus online API docs for JDK 1.2 beta from http://www.javasoft.com. * Status: Believed complete and correct. */ - + +/** + * 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. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + * @author Warren Levy + */ public abstract class FilterReader extends Reader { - /* The input stream to be filtered. */ - protected Reader in; - - protected FilterReader(Reader in) - { - super(in.lock); - this.in = in; - } - - public void close() throws IOException - { - // We used to set `in = null' here. We don't, though, because - // that is the simplest way to ensure that read-after-close will - // throw the appropriate exception -- we rely on the filtered - // stream to do it. - in.close(); - } - - public synchronized void mark(int readlimit) throws IOException - { - in.mark(readlimit); - } - - public boolean markSupported() - { - return in.markSupported(); - } - - public int read() throws IOException - { - return in.read(); - } - - public int read(char[] b, int off, int len) throws IOException - { - return in.read(b, off, len); - } - - public boolean ready() throws IOException - { - return in.ready(); - } - - public synchronized void reset() throws IOException - { - in.reset(); - } - - public long skip(long n) throws IOException - { - return in.skip(n); - } + +/*************************************************************************/ + +/* + * Instance Variables + */ + +/** + * This is the subordinate 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 -- cgit v1.2.3