Commit 93b3986a by Michael Koch Committed by Michael Koch

BufferedOutputStream.java: Reformated.

2003-03-23  Michael Koch  <konqueror@gmx.de>

	* java/io/BufferedOutputStream.java:
	Reformated.
	* java/io/BufferedReader.java:
	Reformated.
	* java/io/ByteArrayOutputStream.java
	(size): Fixed @see tag.
	* java/io/CharArrayWriter.java
	(size): Fixed @see tag.
	* java/io/DataInput.java:
	Reformated.
	* java/io/DataOutput.java:
	Reformated.
	* java/io/DataOutputStream.java:
	Merged copyright years with classpath.
	* java/io/Externalizable.java:
	Reformated.
	* java/io/FileFilter.java:
	Reformated.
	* java/io/FileInputStream.java:
	Merged copyright years with classpath.
	* java/io/FileOutputStream.java:
	Merged copyright years with classpath.
	* java/io/FilePermission.java
	(FilePermission): Replaced @XXX with FIXME:.
	* java/io/FileWriter.java:
	Reformated.
	* java/io/FilenameFilter.java:
	Reformated.
	* java/io/FilterInputStream.java:
	Reformated.
	* java/io/FilterOutputStream.java:
	Reformated.
	* java/io/FilterReader.java:
	Reformated.
	* java/io/FilterWriter.java:
	Reformated.
	* java/io/LineNumberInputStream.java
	(LineNumberInputStream): Replaced @code with HTML tags to make javadoc
	happy.
	(getLineNumber): Fixed @return tag.
	* java/io/ObjectInput.java:
	Reformated.
	* java/io/ObjectOutput.java:
	Reformated.
	* java/io/ObjectStreamClass.java:
	Reformated.
	* java/io/PrintStream.java:
	Merged copyright years with classpath.
	* java/io/PushbackReader.java
	(PushbackReader): Replaced @code with @param.
	* java/io/SerializablePermission.java:
	Reformated.
	* java/io/StreamTokenizer.java
	(resetSyntax): Fixed @see tag.

From-SVN: r64748
parent 4d1da12a
2003-03-23 Michael Koch <konqueror@gmx.de>
* java/io/BufferedOutputStream.java:
Reformated.
* java/io/BufferedReader.java:
Reformated.
* java/io/ByteArrayOutputStream.java
(size): Fixed @see tag.
* java/io/CharArrayWriter.java
(size): Fixed @see tag.
* java/io/DataInput.java:
Reformated.
* java/io/DataOutput.java:
Reformated.
* java/io/DataOutputStream.java:
Merged copyright years with classpath.
* java/io/Externalizable.java:
Reformated.
* java/io/FileFilter.java:
Reformated.
* java/io/FileInputStream.java:
Merged copyright years with classpath.
* java/io/FileOutputStream.java:
Merged copyright years with classpath.
* java/io/FilePermission.java
(FilePermission): Replaced @XXX with FIXME:.
* java/io/FileWriter.java:
Reformated.
* java/io/FilenameFilter.java:
Reformated.
* java/io/FilterInputStream.java:
Reformated.
* java/io/FilterOutputStream.java:
Reformated.
* java/io/FilterReader.java:
Reformated.
* java/io/FilterWriter.java:
Reformated.
* java/io/LineNumberInputStream.java
(LineNumberInputStream): Replaced @code with HTML tags to make javadoc
happy.
(getLineNumber): Fixed @return tag.
* java/io/ObjectInput.java:
Reformated.
* java/io/ObjectOutput.java:
Reformated.
* java/io/ObjectStreamClass.java:
Reformated.
* java/io/PrintStream.java:
Merged copyright years with classpath.
* java/io/PushbackReader.java
(PushbackReader): Replaced @code with @param.
* java/io/SerializablePermission.java:
Reformated.
* java/io/StreamTokenizer.java
(resetSyntax): Fixed @see tag.
2003-03-22 Richard Henderson <rth@redhat.com>
* sysdep/ia64/locks.h: Include ia64intrin.h.
......
......@@ -50,62 +50,44 @@ package java.io;
*/
public class BufferedOutputStream extends FilterOutputStream
{
/*
* Class Variables
*/
/**
* This is the default buffer size
*/
private static final int DEFAULT_BUFFER_SIZE = 512;
/*************************************************************************/
/*
* Instance Variables
* This is the default buffer size
*/
private static final int DEFAULT_BUFFER_SIZE = 512;
/**
* This is the internal byte array used for buffering output before
* writing it.
*/
* This is the internal byte array used for buffering output before
* writing it.
*/
protected byte[] buf;
/**
* This is the number of bytes that are currently in the buffer and
* are waiting to be written to the underlying stream. It always points to
* the index into the buffer where the next byte of data will be stored
*/
protected int count;
/*************************************************************************/
/*
* Constructors
* This is the number of bytes that are currently in the buffer and
* are waiting to be written to the underlying stream. It always points to
* the index into the buffer where the next byte of data will be stored
*/
protected int count;
/**
* This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code>
* and which will use a default buffer size of 512 bytes.
*
* @param out The underlying <code>OutputStream</code> to write data to
*/
* This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code>
* and which will use a default buffer size of 512 bytes.
*
* @param out The underlying <code>OutputStream</code> to write data to
*/
public BufferedOutputStream(OutputStream out)
{
this(out, DEFAULT_BUFFER_SIZE);
}
/*************************************************************************/
/**
* This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code>
* and which will use the specified buffer size
*
* @param out The underlying <code>OutputStream</code> to write data to
* @param size The size of the internal buffer
*/
* This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code>
* and which will use the specified buffer size
*
* @param out The underlying <code>OutputStream</code> to write data to
* @param size The size of the internal buffer
*/
public BufferedOutputStream(OutputStream out, int size)
{
super(out);
......@@ -113,18 +95,12 @@ public class BufferedOutputStream extends FilterOutputStream
buf = new byte[size];
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method causes any currently buffered bytes to be immediately
* written to the underlying output stream.
*
* @exception IOException If an error occurs
*/
* This method causes any currently buffered bytes to be immediately
* written to the underlying output stream.
*
* @exception IOException If an error occurs
*/
public synchronized void flush() throws IOException
{
if (count == 0)
......@@ -135,13 +111,11 @@ public class BufferedOutputStream extends FilterOutputStream
out.flush();
}
/*************************************************************************/
/*
* This method flushes any remaining buffered bytes then closes the
* underlying output stream. Any further attempts to write to this stream
* may throw an exception
*
/**
* This method flushes any remaining buffered bytes then closes the
* underlying output stream. Any further attempts to write to this stream
* may throw an exception
*
public synchronized void close() throws IOException
{
flush();
......@@ -149,33 +123,29 @@ public class BufferedOutputStream extends FilterOutputStream
}
*/
/*************************************************************************/
/*
* This method runs when the object is garbage collected. It is
* responsible for ensuring that all buffered bytes are written and
* for closing the underlying stream.
*
* @exception IOException If an error occurs (ignored by the Java runtime)
*
/**
* This method runs when the object is garbage collected. It is
* responsible for ensuring that all buffered bytes are written and
* for closing the underlying stream.
*
* @exception IOException If an error occurs (ignored by the Java runtime)
*
protected void finalize() throws IOException
{
close();
}
*/
/*************************************************************************/
/**
* This method writes a single byte of data. This will be written to the
* buffer instead of the underlying data source. However, if the buffer
* is filled as a result of this write request, it will be flushed to the
* underlying output stream.
*
* @param b The byte of data to be written, passed as an int
*
* @exception IOException If an error occurs
*/
* This method writes a single byte of data. This will be written to the
* buffer instead of the underlying data source. However, if the buffer
* is filled as a result of this write request, it will be flushed to the
* underlying output stream.
*
* @param b The byte of data to be written, passed as an int
*
* @exception IOException If an error occurs
*/
public synchronized void write(int b) throws IOException
{
if (count == buf.length)
......@@ -185,21 +155,19 @@ public class BufferedOutputStream extends FilterOutputStream
++count;
}
/*************************************************************************/
/**
* This method writes <code>len</code> bytes from the byte array
* <code>buf</code> starting at position <code>offset</code> in the buffer.
* These bytes will be written to the internal buffer. However, if this
* write operation fills the buffer, the buffer will be flushed to the
* underlying output stream.
*
* @param buf The array of bytes to write.
* @param offset The index into the byte array to start writing from.
* @param len The number of bytes to write.
*
* @exception IOException If an error occurs
*/
* This method writes <code>len</code> bytes from the byte array
* <code>buf</code> starting at position <code>offset</code> in the buffer.
* These bytes will be written to the internal buffer. However, if this
* write operation fills the buffer, the buffer will be flushed to the
* underlying output stream.
*
* @param buf The array of bytes to write.
* @param offset The index into the byte array to start writing from.
* @param len The number of bytes to write.
*
* @exception IOException If an error occurs
*/
public synchronized void write(byte[] buf, int offset, int len)
throws IOException
{
......
......@@ -118,7 +118,7 @@ public class ByteArrayOutputStream extends OutputStream
*
* @return The number of bytes in the internal buffer
*
* @see reset
* @see #reset()
*/
public int size ()
{
......
......@@ -130,7 +130,7 @@ public class CharArrayWriter extends Writer
*
* @return The number of chars in the internal buffer
*
* @see reset
* @see #reset()
*/
public int size ()
{
......
......@@ -44,173 +44,147 @@ package java.io;
*/
/**
* This interface is implemented by classes that can wrte data to streams
* from Java primitive types.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com>
*/
* This interface is implemented by classes that can wrte data to streams
* from Java primitive types.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com>
*/
public interface DataOutput
{
/**
* This method writes a Java boolean value to an output stream
*
* @param value The boolean value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java boolean value to an output stream
*
* @param value The boolean value to write
*
* @exception IOException If an error occurs
*/
void writeBoolean(boolean value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java byte value to an output stream
*
* @param value The int value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java byte value to an output stream
*
* @param value The int value to write
*
* @exception IOException If an error occurs
*/
void writeByte(int value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java char value to an output stream
*
* @param value The char value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java char value to an output stream
*
* @param value The char value to write
*
* @exception IOException If an error occurs
*/
void writeChar(int value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java int value to an output stream as a 16 bit value
*
* @param value The int value to write as a 16-bit value
*
* @exception IOException If an error occurs
*/
* This method writes a Java int value to an output stream as a 16 bit value
*
* @param value The int value to write as a 16-bit value
*
* @exception IOException If an error occurs
*/
void writeShort(int value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java int value to an output stream
*
* @param value The int value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java int value to an output stream
*
* @param value The int value to write
*
* @exception IOException If an error occurs
*/
void writeInt(int value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java long value to an output stream
*
* @param value The long value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java long value to an output stream
*
* @param value The long value to write
*
* @exception IOException If an error occurs
*/
void writeLong(long value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java float value to an output stream
*
* @param value The float value to write
*
* @exception IOException If an error occurs
*/
* This method writes a Java float value to an output stream
*
* @param value The float value to write
*
* @exception IOException If an error occurs
*/
void writeFloat(float value) throws IOException;
/*************************************************************************/
/**
* This method writes a Java double value to an output stream
*
* @param value The double value to write
*
* @exception IOException If any other error occurs
*/
* This method writes a Java double value to an output stream
*
* @param value The double value to write
*
* @exception IOException If any other error occurs
*/
void writeDouble(double value) throws IOException;
/*************************************************************************/
/**
* This method writes a String to an output stream as an array of bytes
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
* This method writes a String to an output stream as an array of bytes
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
void writeBytes(String value) throws IOException;
/*************************************************************************/
/**
* This method writes a String to an output stream as an array of char's
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
* This method writes a String to an output stream as an array of char's
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
void writeChars(String value) throws IOException;
/*************************************************************************/
/**
* This method writes a String to an output stream encoded in
* UTF-8 format.
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
* This method writes a String to an output stream encoded in
* UTF-8 format.
*
* @param value The String to write
*
* @exception IOException If an error occurs
*/
void writeUTF(String value) throws IOException;
/*************************************************************************/
/**
* This method writes an 8-bit value (passed into the method as a Java
* int) to an output stream.
*
* @param value The byte to write to the output stream
*
* @exception IOException If an error occurs
*/
* This method writes an 8-bit value (passed into the method as a Java
* int) to an output stream.
*
* @param value The byte to write to the output stream
*
* @exception IOException If an error occurs
*/
void write(int value) throws IOException;
/*************************************************************************/
/**
* This method writes the raw byte array passed in to the output stream.
*
* @param buf The byte array to write
*
* @exception IOException If an error occurs
*/
* This method writes the raw byte array passed in to the output stream.
*
* @param buf The byte array to write
*
* @exception IOException If an error occurs
*/
void write(byte[] buf) throws IOException;
/*************************************************************************/
/**
* This method writes raw bytes from the passed array <code>buf</code>
* starting
* <code>offset</code> bytes into the buffer. The number of bytes
* written will be * exactly <code>len</code>.
*
* @param buf The buffer from which to write the data
* @param offset The offset into the buffer to start writing data from
* @param len The number of bytes to write from the buffer to the output
* stream
*
* @exception IOException If any other error occurs
*/
* This method writes raw bytes from the passed array <code>buf</code>
* starting
* <code>offset</code> bytes into the buffer. The number of bytes
* written will be * exactly <code>len</code>.
*
* @param buf The buffer from which to write the data
* @param offset The offset into the buffer to start writing data from
* @param len The number of bytes to write from the buffer to the output
* stream
*
* @exception IOException If any other error occurs
*/
void write(byte[] buf, int offset, int len) throws IOException;
} // interface DataOutput
......
/* DataOutputStream.java -- Writes primitive Java datatypes to streams
Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc.
Copyright (C) 1998, 2001, 2003 Free Software Foundation, Inc.
This file is part of GNU Classpath.
......
......@@ -39,74 +39,72 @@ exception statement from your version. */
package java.io;
/**
* This interface provides a way that classes can completely control how
* the data of their object instances are written and read to and from
* streams. It has two methods which are used to write the data to a stream
* and to read the data from a stream. The read method must read the data
* in exactly the way it was written by the write method.
* <p>
* Note that classes which implement this interface must take into account
* that all superclass data must also be written to the stream as well.
* The class implementing this interface must figure out how to make that
* happen.
* <p>
* This interface can be used to provide object persistence. When an
* object is to be stored externally, the <code>writeExternal</code> method is
* called to save state. When the object is restored, an instance is
* created using the default no-argument constructor and the
* <code>readExternal</code> method is used to restore the state.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
* This interface provides a way that classes can completely control how
* the data of their object instances are written and read to and from
* streams. It has two methods which are used to write the data to a stream
* and to read the data from a stream. The read method must read the data
* in exactly the way it was written by the write method.
* <p>
* Note that classes which implement this interface must take into account
* that all superclass data must also be written to the stream as well.
* The class implementing this interface must figure out how to make that
* happen.
* <p>
* This interface can be used to provide object persistence. When an
* object is to be stored externally, the <code>writeExternal</code> method is
* called to save state. When the object is restored, an instance is
* created using the default no-argument constructor and the
* <code>readExternal</code> method is used to restore the state.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface Externalizable extends Serializable
{
static final long serialVersionUID = -282491828744381764L;
/**
* This method restores an object's state by reading in the instance data
* for the object from the passed in stream. Note that this stream is not
* a subclass of <code>InputStream</code>, but rather is a class that
* implements
* the <code>ObjectInput</code> interface. That interface provides a
* mechanism for
* reading in Java data types from a stream.
* <p>
* Note that this method must be compatible with <code>writeExternal</code>.
* It must read back the exact same types that were written by that
* method in the exact order they were written.
* <p>
* If this method needs to read back an object instance, then the class
* for that object must be found and loaded. If that operation fails,
* then this method throws a <code>ClassNotFoundException</code>
*
* @param in An <code>ObjectInput</code> instance for reading in the object
* state
*
* @exception ClassNotFoundException If the class of an object being
* restored cannot be found
* @exception IOException If any other error occurs
*/
* This method restores an object's state by reading in the instance data
* for the object from the passed in stream. Note that this stream is not
* a subclass of <code>InputStream</code>, but rather is a class that
* implements
* the <code>ObjectInput</code> interface. That interface provides a
* mechanism for
* reading in Java data types from a stream.
* <p>
* Note that this method must be compatible with <code>writeExternal</code>.
* It must read back the exact same types that were written by that
* method in the exact order they were written.
* <p>
* If this method needs to read back an object instance, then the class
* for that object must be found and loaded. If that operation fails,
* then this method throws a <code>ClassNotFoundException</code>
*
* @param in An <code>ObjectInput</code> instance for reading in the object
* state
*
* @exception ClassNotFoundException If the class of an object being
* restored cannot be found
* @exception IOException If any other error occurs
*/
public abstract void readExternal(ObjectInput in)
throws ClassNotFoundException, IOException;
/*************************************************************************/
/**
* This method is responsible for writing the instance data of an object
* to the passed in stream. Note that this stream is not a subclass of
* <code>OutputStream</code>, but rather is a class that implements the
* <code>ObjectOutput</code> interface. That interface provides a
* number of methods
* for writing Java data values to a stream.
* <p>
* Not that the implementation of this method must be coordinated with
* the implementation of <code>readExternal</code>.
*
* @param out An <code>ObjectOutput</code> instance for writing the
* object state
*
* @exception IOException If an error occurs
*/
* This method is responsible for writing the instance data of an object
* to the passed in stream. Note that this stream is not a subclass of
* <code>OutputStream</code>, but rather is a class that implements the
* <code>ObjectOutput</code> interface. That interface provides a
* number of methods
* for writing Java data values to a stream.
* <p>
* Not that the implementation of this method must be coordinated with
* the implementation of <code>readExternal</code>.
*
* @param out An <code>ObjectOutput</code> instance for writing the
* object state
*
* @exception IOException If an error occurs
*/
public abstract void writeExternal(ObjectOutput out) throws IOException;
} // interface Externalizable
......
......@@ -39,27 +39,27 @@ exception statement from your version. */
package java.io;
/**
* This interface has one method which is used for filtering pathnames
* returned in a pathname listing. It is currently used by the
* <code>File.listFiles()</code> method.
* <p>
* The method in this interface determines if a particular pathname should
* or should not be included in the pathname listing.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
* This interface has one method which is used for filtering pathnames
* returned in a pathname listing. It is currently used by the
* <code>File.listFiles()</code> method.
* <p>
* The method in this interface determines if a particular pathname should
* or should not be included in the pathname listing.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface FileFilter
{
/**
* This method determines whether or not a given pathname should be included
* in a pathname listing.
*
* @param pathname The pathname to test
*
* @return <code>true</code> if the path should be included in the list,
* <code>false</code> otherwise.
*/
* This method determines whether or not a given pathname should be included
* in a pathname listing.
*
* @param pathname The pathname to test
*
* @return <code>true</code> if the path should be included in the list,
* <code>false</code> otherwise.
*/
public abstract boolean accept(File pathname);
} // interface FileFilter
......
/* FileInputStream.java -- An input stream that reads from disk files.
Copyright (C) 1998, 1999, 2001, 2002, 2003 Free Software Foundation, Inc.
Copyright (C) 1998, 2002, 2003 Free Software Foundation, Inc.
This file is part of GNU Classpath.
......
/* FileOutputStream.java -- Writes to a file on disk.
Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc.
Copyright (C) 1998, 2001, 2003 Free Software Foundation, Inc.
This file is part of GNU Classpath.
......
......@@ -93,7 +93,7 @@ public final class FilePermission extends Permission implements Serializable
** permission represents.
** @param actionsString a comma-separated list of the actions this
** permission represents.
** @XXX what to do when the file string is malformed?
** FIXME: what to do when the file string is malformed?
**/
public FilePermission(String pathExpression, String actionsString)
{
......
......@@ -54,8 +54,6 @@ package java.io;
public class FileWriter extends OutputStreamWriter
{
/*************************************************************************/
/*
* Constructors
*/
......@@ -75,8 +73,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(file));
}
/*************************************************************************/
/**
* This method initializes a new <code>FileWriter</code> object to write
* to the specified <code>File</code> object.
......@@ -94,8 +90,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(file, append));
}
/*************************************************************************/
/**
* This method initializes a new <code>FileWriter</code> object to write
* to the specified <code>FileDescriptor</code> object.
......@@ -110,8 +104,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(fd));
}
/*************************************************************************/
/**
* This method intializes a new <code>FileWriter</code> object to
* write to the
......@@ -128,8 +120,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(name));
}
/*************************************************************************/
/**
* This method intializes a new <code>FileWriter</code> object to
* write to the
......
......@@ -44,29 +44,29 @@ package java.io;
*/
/**
* This interface has one method which is used for filtering filenames
* returned in a directory listing. It is currently used by the
* <code>File.list()</code> method and by the filename dialog in AWT.
* <p>
* The method in this interface determines if a particular file should
* or should not be included in the file listing.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com>
*/
* This interface has one method which is used for filtering filenames
* returned in a directory listing. It is currently used by the
* <code>File.list()</code> method and by the filename dialog in AWT.
* <p>
* The method in this interface determines if a particular file should
* or should not be included in the file listing.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com>
*/
public interface FilenameFilter
{
/**
* This method determines whether or not a given file should be included
* in a directory listing.
*
* @param dir The <code>File</code> instance for the directory being read
* @param name The name of the file to test
*
* @return <code>true</code> if the file should be included in the list,
* <code>false</code> otherwise.
*/
* This method determines whether or not a given file should be included
* in a directory listing.
*
* @param dir The <code>File</code> instance for the directory being read
* @param name The name of the file to test
*
* @return <code>true</code> if the file should be included in the list,
* <code>false</code> otherwise.
*/
boolean accept(File dir, String name);
} // interface FilenameFilter
......
......@@ -69,25 +69,12 @@ package java.io;
*/
public class FilterInputStream extends InputStream
{
/*************************************************************************/
/*
* Instance Variables
*/
/**
* This is the subordinate <code>InputStream</code> to which method calls
* are redirected
*/
protected InputStream in;
/*************************************************************************/
/*
* Constructors
*/
/**
* Create a <code>FilterInputStream</code> with the specified subordinate
* <code>InputStream</code>.
......@@ -99,12 +86,6 @@ public class FilterInputStream extends InputStream
this.in = in;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* Calls the <code>in.mark(int)</code> method.
*
......@@ -115,8 +96,6 @@ public class FilterInputStream extends InputStream
in.mark(readlimit);
}
/*************************************************************************/
/**
* Calls the <code>in.markSupported()</code> method.
*
......@@ -128,8 +107,6 @@ public class FilterInputStream extends InputStream
return(in.markSupported());
}
/*************************************************************************/
/**
* Calls the <code>in.reset()</code> method.
*
......@@ -140,8 +117,6 @@ public class FilterInputStream extends InputStream
in.reset();
}
/*************************************************************************/
/**
* Calls the <code>in.available()</code> method.
*
......@@ -154,8 +129,6 @@ public class FilterInputStream extends InputStream
return(in.available());
}
/*************************************************************************/
/**
* Calls the <code>in.skip(long)</code> method
*
......@@ -170,8 +143,6 @@ public class FilterInputStream extends InputStream
return(in.skip(num_bytes));
}
/*************************************************************************/
/**
* Calls the <code>in.read()</code> method
*
......@@ -184,8 +155,6 @@ public class FilterInputStream extends InputStream
return(in.read());
}
/*************************************************************************/
/**
* Calls the <code>read(byte[], int, int)</code> overloaded method.
* Note that
......@@ -204,8 +173,6 @@ public class FilterInputStream extends InputStream
return(read(buf, 0, buf.length));
}
/*************************************************************************/
/**
* Calls the <code>in.read(byte[], int, int)</code> method.
*
......@@ -222,8 +189,6 @@ public class FilterInputStream extends InputStream
return(in.read(buf, offset, len));
}
/*************************************************************************/
/**
* This method closes the input stream by closing the input stream that
* this object is filtering. Future attempts to access this stream may
......
......@@ -56,25 +56,12 @@ package java.io;
*/
public class FilterOutputStream extends OutputStream
{
/*************************************************************************/
/*
* Instance Variables
*/
/**
* This is the subordinate <code>OutputStream</code> that this class
* redirects its method calls to.
*/
protected OutputStream out;
/*************************************************************************/
/*
* Constructors
*/
/**
* This method initializes an instance of <code>FilterOutputStream</code>
* to write to the specified subordinate <code>OutputStream</code>.
......@@ -86,12 +73,6 @@ public class FilterOutputStream extends OutputStream
this.out = out;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method closes the underlying <code>OutputStream</code>. Any
* further attempts to write to this stream may throw an exception.
......@@ -104,8 +85,6 @@ public class FilterOutputStream extends OutputStream
out.close();
}
/*************************************************************************/
/**
* This method attempt to flush all buffered output to be written to the
* underlying output sink.
......@@ -117,8 +96,6 @@ public class FilterOutputStream extends OutputStream
out.flush();
}
/*************************************************************************/
/**
* This method writes a single byte of output to the underlying
* <code>OutputStream</code>.
......@@ -132,8 +109,6 @@ public class FilterOutputStream extends OutputStream
out.write(b);
}
/*************************************************************************/
/**
* This method writes all the bytes in the specified array to the underlying
* <code>OutputStream</code>. It does this by calling the three parameter
......@@ -151,8 +126,6 @@ public class FilterOutputStream extends OutputStream
write(buf, 0, buf.length);
}
/*************************************************************************/
/**
* This method calls the <code>write(int)</code> method <code>len</code>
* times for all bytes from the array <code>buf</code> starting at index
......
......@@ -63,22 +63,12 @@ package java.io;
*/
public abstract class FilterReader extends Reader
{
/*
* Instance Variables
*/
/**
* This is the subordinate <code>Reader</code> to which method calls
* are redirected
*/
protected Reader in;
/*************************************************************************/
/*
* Constructors
*/
/**
* Create a <code>FilterReader</code> with the specified subordinate
* <code>Reader</code>.
......@@ -93,12 +83,6 @@ public abstract class FilterReader extends Reader
this.in = in;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* Calls the <code>in.mark(int)</code> method.
*
......@@ -111,8 +95,6 @@ public abstract class FilterReader extends Reader
in.mark(readlimit);
}
/*************************************************************************/
/**
* Calls the <code>in.markSupported()</code> method.
*
......@@ -124,8 +106,6 @@ public abstract class FilterReader extends Reader
return(in.markSupported());
}
/*************************************************************************/
/**
* Calls the <code>in.reset()</code> method.
*
......@@ -136,8 +116,6 @@ public abstract class FilterReader extends Reader
in.reset();
}
/*************************************************************************/
/**
* Calls the <code>in.read()</code> method.
*
......@@ -150,8 +128,6 @@ public abstract class FilterReader extends Reader
return(in.ready());
}
/*************************************************************************/
/**
* Calls the <code>in.skip(long)</code> method
*
......@@ -166,8 +142,6 @@ public abstract class FilterReader extends Reader
return(in.skip(num_chars));
}
/*************************************************************************/
/**
* Calls the <code>in.read()</code> method
*
......@@ -180,8 +154,6 @@ public abstract class FilterReader extends Reader
return(in.read());
}
/*************************************************************************/
/**
* Calls the <code>in.read(char[], int, int)</code> method.
*
......@@ -198,8 +170,6 @@ public abstract class FilterReader extends Reader
return(in.read(buf, offset, len));
}
/*************************************************************************/
/**
* This method closes the stream by calling the <code>close()</code> method
* of the underlying stream.
......
......@@ -56,22 +56,12 @@ package java.io;
*/
public abstract class FilterWriter extends Writer
{
/*
* Instance Variables
*/
/**
* This is the subordinate <code>Writer</code> that this class
* redirects its method calls to.
*/
protected Writer out;
/*************************************************************************/
/*
* Constructors
*/
/**
* This method initializes an instance of <code>FilterWriter</code>
* to write to the specified subordinate <code>Writer</code>.
......@@ -86,12 +76,6 @@ public abstract class FilterWriter extends Writer
this.out = out;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method closes the underlying <code>Writer</code>. Any
* further attempts to write to this stream may throw an exception.
......@@ -103,8 +87,6 @@ public abstract class FilterWriter extends Writer
out.close();
}
/*************************************************************************/
/**
* This method attempt to flush all buffered output to be written to the
* underlying output sink.
......@@ -116,8 +98,6 @@ public abstract class FilterWriter extends Writer
out.flush();
}
/*************************************************************************/
/**
* This method writes a single char of output to the underlying
* <code>Writer</code>.
......@@ -131,8 +111,6 @@ public abstract class FilterWriter extends Writer
out.write(b);
}
/*************************************************************************/
/**
* This method writes <code>len</code> chars from the array <code>buf</code>
* starting at index <code>offset</code> to the underlying
......@@ -149,8 +127,6 @@ public abstract class FilterWriter extends Writer
out.write(buf, offset, len);
}
/*************************************************************************/
/**
* This method writes <code>len</code> chars from the <code>String</code>
* starting at position <code>offset</code>.
......
......@@ -57,7 +57,7 @@ package java.io;
* stream, it has the same mark/reset functionality as the underlying
* stream. The <code>mark()</code> and <code>reset()</code> methods
* in this class handle line numbers correctly. Calling
* @code{reset()} resets the line number to the point at which
* <code>reset()</code> resets the line number to the point at which
* <code>mark()</code> was called if the subordinate stream supports
* that functionality.
* <p>
......@@ -119,7 +119,7 @@ public class LineNumberInputStream extends FilterInputStream
/**
* This method returns the current line number
*
* @returns The current line number
* @return The current line number
*/
public int getLineNumber()
{
......
......@@ -58,8 +58,6 @@ public interface ObjectInput extends DataInput
*/
public abstract int available() throws IOException;
/*************************************************************************/
/**
* This method reading a byte of data from a stream. It returns that byte
* as an int. This method blocks if no data is available to be read.
......@@ -70,8 +68,6 @@ public interface ObjectInput extends DataInput
*/
public abstract int read() throws IOException;
/*************************************************************************/
/**
* This method reads raw bytes and stores them them a byte array buffer.
* Note that this method will block if no data is available. However,
......@@ -86,8 +82,6 @@ public interface ObjectInput extends DataInput
*/
public abstract int read(byte[] buf) throws IOException;
/*************************************************************************/
/**
* This method reads raw bytes and stores them in a byte array buffer
* <code>buf</code> starting at position <code>offset</code> into the
......@@ -107,8 +101,6 @@ public interface ObjectInput extends DataInput
*/
public abstract int read(byte[] buf, int offset, int len) throws IOException;
/*************************************************************************/
/**
* Reads an object instance and returns it. If the class for the object
* being read cannot be found, then a ClassNotFoundException will
......@@ -123,8 +115,6 @@ public interface ObjectInput extends DataInput
public abstract Object readObject()
throws ClassNotFoundException, IOException;
/*************************************************************************/
/**
* This method causes the specified number of bytes to be read and
* discarded. It is possible that fewer than the requested number of bytes
......@@ -138,8 +128,6 @@ public interface ObjectInput extends DataInput
*/
public abstract long skip(long num_bytes) throws IOException;
/*************************************************************************/
/**
* This method closes the input source
*
......
......@@ -58,8 +58,6 @@ public interface ObjectOutput extends DataOutput
*/
public abstract void write(int b) throws IOException;
/*************************************************************************/
/**
* This method writes all the bytes in the specified byte array to the
* output stream.
......@@ -70,8 +68,6 @@ public interface ObjectOutput extends DataOutput
*/
public abstract void write(byte[] buf) throws IOException;
/*************************************************************************/
/**
* This method writes <code>len</code> bytes from the specified array
* starting at index <code>offset</code> into that array.
......@@ -85,8 +81,6 @@ public interface ObjectOutput extends DataOutput
public abstract void write(byte[] buf, int offset, int len)
throws IOException;
/*************************************************************************/
/**
* This method writes a object instance to a stream. The format of the
* data written is determined by the actual implementation of this method
......@@ -97,8 +91,6 @@ public interface ObjectOutput extends DataOutput
*/
public abstract void writeObject(Object obj) throws IOException;
/*************************************************************************/
/**
* This method causes any buffered data to be flushed out to the underlying
* stream
......@@ -107,8 +99,6 @@ public interface ObjectOutput extends DataOutput
*/
public abstract void flush() throws IOException;
/*************************************************************************/
/**
* This method closes the underlying stream.
*
......
......@@ -166,14 +166,14 @@ public class ObjectStreamClass implements Serializable
/**
Returns a textual representation of this
<code>ObjectStreamClass</code> object including the name of the
class it represents as well as that class's serial version
stream-unique identifier.
@see getSerialVersionUID ()
@see getName ()
*/
* Returns a textual representation of this
* <code>ObjectStreamClass</code> object including the name of the
* class it represents as well as that class's serial version
* stream-unique identifier.
*
* @see #getSerialVersionUID()
* @see #getName()
*/
public String toString ()
{
return "java.io.ObjectStreamClass< " + name + ", " + uid + " >";
......
/* PrintStream.java -- OutputStream for printing output
Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc.
Copyright (C) 1998,2003 Free Software Foundation, Inc.
This file is part of GNU Classpath.
......
......@@ -77,7 +77,7 @@ public class PushbackReader extends FilterReader
* specified subordinate <code>Reader</code> with a default pushback buffer
* size of 1.
*
* @code in The subordinate stream to read from
* @param in The subordinate stream to read from
*/
public PushbackReader(Reader in)
{
......
......@@ -67,8 +67,6 @@ public final class SerializablePermission extends BasicPermission
private static final String[] legal_names = { "enableSubclassImplementation",
"enableSubstitution" };
/*************************************************************************/
/*
* Constructors
*/
......@@ -88,8 +86,6 @@ public final class SerializablePermission extends BasicPermission
this(name, null);
}
/*************************************************************************/
/**
* This method initializes a new instance of
* <code>SerializablePermission</code>
......
......@@ -580,7 +580,7 @@ public class StreamTokenizer
* quote, and comment) from all characters. It is equivalent to calling
* <code>ordinaryChars(0x00, 0xFF)</code>.
*
* @see ordinaryChars
* @see #ordinaryChars(int, int)
*/
public void resetSyntax()
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment