Skip to content

R
riscv-gcc-1
Commit 93b3986a by Michael Koch Committed by Michael Koch
Options

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
Showing with 786 additions and 969 deletions
libjava/ChangeLog
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> 2003-03-22 Richard Henderson <rth@redhat.com>
* sysdep/ia64/locks.h: Include ia64intrin.h. * sysdep/ia64/locks.h: Include ia64intrin.h.
......
libjava/java/io/BufferedOutputStream.java
...@@ -50,62 +50,44 @@ package java.io; ...@@ -50,62 +50,44 @@ package java.io;
*/ */
public class BufferedOutputStream extends FilterOutputStream public class BufferedOutputStream extends FilterOutputStream
{ {
/*
* Class Variables
*/
/** /**
* This is the default buffer size * This is the default buffer size
*/
private static final int DEFAULT_BUFFER_SIZE = 512;
/*************************************************************************/
/*
* Instance Variables
*/ */
private static final int DEFAULT_BUFFER_SIZE = 512;
/** /**
* This is the internal byte array used for buffering output before * This is the internal byte array used for buffering output before
* writing it. * writing it.
*/ */
protected byte[] buf; protected byte[] buf;
/** /**
* This is the number of bytes that are currently in the buffer and * 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 * 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 * the index into the buffer where the next byte of data will be stored
*/
protected int count;
/*************************************************************************/
/*
* Constructors
*/ */
protected int count;
/** /**
* This method initializes a new <code>BufferedOutputStream</code> instance * This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code> * that will write to the specified subordinate <code>OutputStream</code>
* and which will use a default buffer size of 512 bytes. * and which will use a default buffer size of 512 bytes.
* *
* @param out The underlying <code>OutputStream</code> to write data to * @param out The underlying <code>OutputStream</code> to write data to
*/ */
public BufferedOutputStream(OutputStream out) public BufferedOutputStream(OutputStream out)
{ {
this(out, DEFAULT_BUFFER_SIZE); this(out, DEFAULT_BUFFER_SIZE);
} }
/*************************************************************************/
/** /**
* This method initializes a new <code>BufferedOutputStream</code> instance * This method initializes a new <code>BufferedOutputStream</code> instance
* that will write to the specified subordinate <code>OutputStream</code> * that will write to the specified subordinate <code>OutputStream</code>
* and which will use the specified buffer size * and which will use the specified buffer size
* *
* @param out The underlying <code>OutputStream</code> to write data to * @param out The underlying <code>OutputStream</code> to write data to
* @param size The size of the internal buffer * @param size The size of the internal buffer
*/ */
public BufferedOutputStream(OutputStream out, int size) public BufferedOutputStream(OutputStream out, int size)
{ {
super(out); super(out);
...@@ -113,18 +95,12 @@ public class BufferedOutputStream extends FilterOutputStream ...@@ -113,18 +95,12 @@ public class BufferedOutputStream extends FilterOutputStream
buf = new byte[size]; buf = new byte[size];
} }
/*************************************************************************/
/*
* Instance Methods
*/
/** /**
* This method causes any currently buffered bytes to be immediately * This method causes any currently buffered bytes to be immediately
* written to the underlying output stream. * written to the underlying output stream.
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public synchronized void flush() throws IOException public synchronized void flush() throws IOException
{ {
if (count == 0) if (count == 0)
...@@ -135,13 +111,11 @@ public class BufferedOutputStream extends FilterOutputStream ...@@ -135,13 +111,11 @@ public class BufferedOutputStream extends FilterOutputStream
out.flush(); out.flush();
} }
/*************************************************************************/ /**
* This method flushes any remaining buffered bytes then closes the
/* * underlying output stream. Any further attempts to write to this stream
* This method flushes any remaining buffered bytes then closes the * may throw an exception
* underlying output stream. Any further attempts to write to this stream *
* may throw an exception
*
public synchronized void close() throws IOException public synchronized void close() throws IOException
{ {
flush(); flush();
...@@ -149,33 +123,29 @@ public class BufferedOutputStream extends FilterOutputStream ...@@ -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
* This method runs when the object is garbage collected. It is * for closing the underlying stream.
* 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)
* *
* @exception IOException If an error occurs (ignored by the Java runtime)
*
protected void finalize() throws IOException protected void finalize() throws IOException
{ {
close(); close();
} }
*/ */
/*************************************************************************/
/** /**
* This method writes a single byte of data. This will be written to the * 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 * 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 * is filled as a result of this write request, it will be flushed to the
* underlying output stream. * underlying output stream.
* *
* @param b The byte of data to be written, passed as an int * @param b The byte of data to be written, passed as an int
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public synchronized void write(int b) throws IOException public synchronized void write(int b) throws IOException
{ {
if (count == buf.length) if (count == buf.length)
...@@ -185,21 +155,19 @@ public class BufferedOutputStream extends FilterOutputStream ...@@ -185,21 +155,19 @@ public class BufferedOutputStream extends FilterOutputStream
++count; ++count;
} }
/*************************************************************************/
/** /**
* This method writes <code>len</code> bytes from the byte array * This method writes <code>len</code> bytes from the byte array
* <code>buf</code> starting at position <code>offset</code> in the buffer. * <code>buf</code> starting at position <code>offset</code> in the buffer.
* These bytes will be written to the internal buffer. However, if this * These bytes will be written to the internal buffer. However, if this
* write operation fills the buffer, the buffer will be flushed to the * write operation fills the buffer, the buffer will be flushed to the
* underlying output stream. * underlying output stream.
* *
* @param buf The array of bytes to write. * @param buf The array of bytes to write.
* @param offset The index into the byte array to start writing from. * @param offset The index into the byte array to start writing from.
* @param len The number of bytes to write. * @param len The number of bytes to write.
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public synchronized void write(byte[] buf, int offset, int len) public synchronized void write(byte[] buf, int offset, int len)
throws IOException throws IOException
{ {
......
libjava/java/io/BufferedReader.java
...@@ -44,19 +44,19 @@ package java.io; ...@@ -44,19 +44,19 @@ package java.io;
*/ */
/** /**
* This subclass of <code>FilterReader</code> buffers input from an * This subclass of <code>FilterReader</code> buffers input from an
* underlying implementation to provide a possibly more efficient read * underlying implementation to provide a possibly more efficient read
* mechanism. It maintains the buffer and buffer state in instance * mechanism. It maintains the buffer and buffer state in instance
* variables that are available to subclasses. The default buffer size * variables that are available to subclasses. The default buffer size
* of 512 chars can be overridden by the creator of the stream. * of 512 chars can be overridden by the creator of the stream.
* <p> * <p>
* This class also implements mark/reset functionality. It is capable * This class also implements mark/reset functionality. It is capable
* of remembering any number of input chars, to the limits of * of remembering any number of input chars, to the limits of
* system memory or the size of <code>Integer.MAX_VALUE</code> * system memory or the size of <code>Integer.MAX_VALUE</code>
* *
* @author Per Bothner <bothner@cygnus.com> * @author Per Bothner <bothner@cygnus.com>
* @author Aaron M. Renn <arenn@urbanophile.com> * @author Aaron M. Renn <arenn@urbanophile.com>
*/ */
public class BufferedReader extends Reader public class BufferedReader extends Reader
{ {
Reader in; Reader in;
...@@ -99,13 +99,13 @@ public class BufferedReader extends Reader ...@@ -99,13 +99,13 @@ public class BufferedReader extends Reader
} }
/** /**
* Create a new <code>BufferedReader</code> that will read from the * Create a new <code>BufferedReader</code> that will read from the
* specified subordinate stream with a buffer size that is specified by the * specified subordinate stream with a buffer size that is specified by the
* caller. * caller.
* *
* @param in The subordinate stream to read from * @param in The subordinate stream to read from
* @param bufsize The buffer size to use * @param bufsize The buffer size to use
*/ */
public BufferedReader(Reader in, int size) public BufferedReader(Reader in, int size)
{ {
super(in.lock); super(in.lock);
...@@ -114,10 +114,10 @@ public class BufferedReader extends Reader ...@@ -114,10 +114,10 @@ public class BufferedReader extends Reader
} }
/** /**
* This method closes the stream * This method closes the stream
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public void close() throws IOException public void close() throws IOException
{ {
synchronized (lock) synchronized (lock)
...@@ -130,36 +130,36 @@ public class BufferedReader extends Reader ...@@ -130,36 +130,36 @@ public class BufferedReader extends Reader
} }
/** /**
* Returns <code>true</code> to indicate that this class supports mark/reset * Returns <code>true</code> to indicate that this class supports mark/reset
* functionality. * functionality.
* *
* @return <code>true</code> * @return <code>true</code>
*/ */
public boolean markSupported() public boolean markSupported()
{ {
return true; return true;
} }
/** /**
* Mark a position in the input to which the stream can be * Mark a position in the input to which the stream can be
* "reset" by calling the <code>reset()</code> method. The parameter * "reset" by calling the <code>reset()</code> method. The parameter
* <code>readlimit</code> is the number of chars that can be read from the * <code>readlimit</code> is the number of chars that can be read from the
* stream after setting the mark before the mark becomes invalid. For * stream after setting the mark before the mark becomes invalid. For
* example, if <code>mark()</code> is called with a read limit of 10, then * example, if <code>mark()</code> is called with a read limit of 10, then
* when 11 chars of data are read from the stream before the * when 11 chars of data are read from the stream before the
* <code>reset()</code> method is called, then the mark is invalid and the * <code>reset()</code> method is called, then the mark is invalid and the
* stream object instance is not required to remember the mark. * stream object instance is not required to remember the mark.
* <p> * <p>
* Note that the number of chars that can be remembered by this method * Note that the number of chars that can be remembered by this method
* can be greater than the size of the internal read buffer. It is also * can be greater than the size of the internal read buffer. It is also
* not dependent on the subordinate stream supporting mark/reset * not dependent on the subordinate stream supporting mark/reset
* functionality. * functionality.
* *
* @param readlimit The number of chars that can be read before the mark * @param readlimit The number of chars that can be read before the mark
* becomes invalid * becomes invalid
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public void mark(int readLimit) throws IOException public void mark(int readLimit) throws IOException
{ {
synchronized (lock) synchronized (lock)
...@@ -207,16 +207,16 @@ public class BufferedReader extends Reader ...@@ -207,16 +207,16 @@ public class BufferedReader extends Reader
} }
/** /**
* Reset the stream to the point where the <code>mark()</code> method * Reset the stream to the point where the <code>mark()</code> method
* was called. Any chars that were read after the mark point was set will * was called. Any chars that were read after the mark point was set will
* be re-read during subsequent reads. * be re-read during subsequent reads.
* <p> * <p>
* This method will throw an IOException if the number of chars read from * This method will throw an IOException if the number of chars read from
* the stream since the call to <code>mark()</code> exceeds the mark limit * the stream since the call to <code>mark()</code> exceeds the mark limit
* passed when establishing the mark. * passed when establishing the mark.
* *
* @exception IOException If an error occurs; * @exception IOException If an error occurs;
*/ */
public void reset() throws IOException public void reset() throws IOException
{ {
synchronized (lock) synchronized (lock)
...@@ -239,15 +239,15 @@ public class BufferedReader extends Reader ...@@ -239,15 +239,15 @@ public class BufferedReader extends Reader
} }
/** /**
* This method determines whether or not a stream is ready to be read. If * This method determines whether or not a stream is ready to be read. If
* This method returns <code>false</code> then this stream could (but is * This method returns <code>false</code> then this stream could (but is
* not guaranteed to) block on the next read attempt. * not guaranteed to) block on the next read attempt.
* *
* @return <code>true</code> if this stream is ready to be read, * @return <code>true</code> if this stream is ready to be read,
* <code>false</code> otherwise * <code>false</code> otherwise
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public boolean ready() throws IOException public boolean ready() throws IOException
{ {
synchronized (lock) synchronized (lock)
...@@ -258,24 +258,24 @@ public class BufferedReader extends Reader ...@@ -258,24 +258,24 @@ public class BufferedReader extends Reader
} }
/** /**
* This method read chars from a stream and stores them into a caller * This method read chars from a stream and stores them into a caller
* supplied buffer. It starts storing the data at index * supplied buffer. It starts storing the data at index
* <code>offset</code> into * <code>offset</code> into
* the buffer and attempts to read <code>len</code> chars. This method can * the buffer and attempts to read <code>len</code> chars. This method can
* return before reading the number of chars requested. The actual number * return before reading the number of chars requested. The actual number
* of chars read is returned as an int. A -1 is returned to indicate the * of chars read is returned as an int. A -1 is returned to indicate the
* end of the stream. * end of the stream.
* <p> * <p>
* This method will block until some data can be read. * This method will block until some data can be read.
* *
* @param buf The array into which the chars read should be stored * @param buf The array into which the chars read should be stored
* @param offset The offset into the array to start storing chars * @param offset The offset into the array to start storing chars
* @param count The requested number of chars to read * @param count The requested number of chars to read
* *
* @return The actual number of chars read, or -1 if end of stream. * @return The actual number of chars read, or -1 if end of stream.
* *
* @exception IOException If an error occurs. * @exception IOException If an error occurs.
*/ */
public int read(char[] buf, int offset, int count) throws IOException public int read(char[] buf, int offset, int count) throws IOException
{ {
synchronized (lock) synchronized (lock)
...@@ -396,16 +396,16 @@ public class BufferedReader extends Reader ...@@ -396,16 +396,16 @@ public class BufferedReader extends Reader
} }
/** /**
* This method reads a single line of text from the input stream, returning * This method reads a single line of text from the input stream, returning
* it as a <code>String</code>. A line is terminated by "\n", a "\r", or * it as a <code>String</code>. A line is terminated by "\n", a "\r", or
* an "\r\n" sequence. The system dependent line separator is not used. * an "\r\n" sequence. The system dependent line separator is not used.
* The line termination characters are not returned in the resulting * The line termination characters are not returned in the resulting
* <code>String</code>. * <code>String</code>.
* *
* @return The line of text read, or <code>null</code> if end of stream. * @return The line of text read, or <code>null</code> if end of stream.
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public String readLine() throws IOException public String readLine() throws IOException
{ {
checkStatus(); checkStatus();
...@@ -470,20 +470,20 @@ public class BufferedReader extends Reader ...@@ -470,20 +470,20 @@ public class BufferedReader extends Reader
} }
/** /**
* This method skips the specified number of chars in the stream. It * This method skips the specified number of chars in the stream. It
* returns the actual number of chars skipped, which may be less than the * returns the actual number of chars skipped, which may be less than the
* requested amount. * requested amount.
* <p> * <p>
* This method first discards chars in the buffer, then calls the * This method first discards chars in the buffer, then calls the
* <code>skip</code> method on the underlying stream to skip the * <code>skip</code> method on the underlying stream to skip the
* remaining chars. * remaining chars.
* *
* @param num_chars The requested number of chars to skip * @param num_chars The requested number of chars to skip
* *
* @return The actual number of chars skipped. * @return The actual number of chars skipped.
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public long skip(long count) throws IOException public long skip(long count) throws IOException
{ {
synchronized (lock) synchronized (lock)
......
libjava/java/io/ByteArrayOutputStream.java
...@@ -118,7 +118,7 @@ public class ByteArrayOutputStream extends OutputStream ...@@ -118,7 +118,7 @@ public class ByteArrayOutputStream extends OutputStream
* *
* @return The number of bytes in the internal buffer * @return The number of bytes in the internal buffer
* *
* @see reset * @see #reset()
*/ */
public int size () public int size ()
{ {
......
libjava/java/io/CharArrayWriter.java
...@@ -130,7 +130,7 @@ public class CharArrayWriter extends Writer ...@@ -130,7 +130,7 @@ public class CharArrayWriter extends Writer
* *
* @return The number of chars in the internal buffer * @return The number of chars in the internal buffer
* *
* @see reset * @see #reset()
*/ */
public int size () public int size ()
{ {
......
libjava/java/io/DataInput.java
...@@ -44,431 +44,403 @@ package java.io; ...@@ -44,431 +44,403 @@ package java.io;
* Status: Believed complete and correct. */ * Status: Believed complete and correct. */
/** /**
* This interface is implemented by classes that can data from streams * This interface is implemented by classes that can data from streams
* into Java primitive types. * into Java primitive types.
* *
* @author Aaron M. Renn (arenn@urbanophile.com) * @author Aaron M. Renn (arenn@urbanophile.com)
* @author Warren Levy <warrenl@cygnus.com> * @author Warren Levy <warrenl@cygnus.com>
*/ */
public interface DataInput public interface DataInput
{ {
/** /**
* This method reads a Java boolean value from an input stream. It does * This method reads a Java boolean value from an input stream. It does
* so by reading a single byte of data. If that byte is zero, then the * so by reading a single byte of data. If that byte is zero, then the
* value returned is <code>false</code>. If the byte is non-zero, then * value returned is <code>false</code>. If the byte is non-zero, then
* the value returned is <code>true</code>. * the value returned is <code>true</code>.
* <p> * <p>
* This method can read a <code>boolean</code> written by an object * This method can read a <code>boolean</code> written by an object
* implementing the <code>writeBoolean()</code> method in the * implementing the <code>writeBoolean()</code> method in the
* <code>DataOutput</code> interface. * <code>DataOutput</code> interface.
* *
* @return The <code>boolean</code> value read * @return The <code>boolean</code> value read
* *
* @exception EOFException If end of file is reached before * @exception EOFException If end of file is reached before
* reading the boolean * reading the boolean
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
boolean readBoolean() throws EOFException, IOException; boolean readBoolean() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java byte value from an input stream. The value * This method reads a Java byte value from an input stream. The value
* is in the range of -128 to 127. * is in the range of -128 to 127.
* <p> * <p>
* This method can read a <code>byte</code> written by an object * This method can read a <code>byte</code> written by an object
* implementing the * implementing the
* <code>writeByte()</code> method in the <code>DataOutput</code> interface. * <code>writeByte()</code> method in the <code>DataOutput</code> interface.
* <p> * <p>
* @return The <code>byte</code> value read * @return The <code>byte</code> value read
* *
* @exception EOFException If end of file is reached before reading the byte * @exception EOFException If end of file is reached before reading the byte
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
byte readByte() throws EOFException, IOException; byte readByte() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads 8 unsigned bits into a Java <code>int</code> value from * This method reads 8 unsigned bits into a Java <code>int</code> value from
* the stream. The value returned is in the range of 0 to 255. * the stream. The value returned is in the range of 0 to 255.
* <p> * <p>
* This method can read an unsigned byte written by an object * This method can read an unsigned byte written by an object
* implementing the * implementing the
* <code>writeUnsignedByte()</code> method in the <code>DataOutput</code> * <code>writeUnsignedByte()</code> method in the <code>DataOutput</code>
* interface. * interface.
* *
* @return The unsigned bytes value read as a Java <code>int</code>. * @return The unsigned bytes value read as a Java <code>int</code>.
* *
* @exception EOFException If end of file is reached before reading the value * @exception EOFException If end of file is reached before reading the value
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
int readUnsignedByte() throws EOFException, IOException; int readUnsignedByte() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java <code>char</code> value from an input stream. * This method reads a Java <code>char</code> value from an input stream.
* It operates by reading two bytes from the stream and converting them to * It operates by reading two bytes from the stream and converting them to
* a single 16-bit Java <code>char</code>. The two bytes are stored most * a single 16-bit Java <code>char</code>. The two bytes are stored most
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> and <code>byte2</code> represent the * As an example, if <code>byte1</code> and <code>byte2</code> represent the
* first and second byte read from the stream respectively, they will be * first and second byte read from the stream respectively, they will be
* transformed to a <code>char</code> in the following manner: * transformed to a <code>char</code> in the following manner:
* <p> * <p>
* <code>(char)((byte1 << 8) + byte2)</code> * <code>(char)((byte1 << 8) + byte2)</code>
* <p> * <p>
* This method can read a <code>char</code> written by an object implementing * This method can read a <code>char</code> written by an object implementing
* the * the
* <code>writeChar()</code> method in the <code>DataOutput</code> interface. * <code>writeChar()</code> method in the <code>DataOutput</code> interface.
* *
* @return The <code>char</code> value read * @return The <code>char</code> value read
* *
* @exception EOFException If end of file is reached before reading the char * @exception EOFException If end of file is reached before reading the char
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
char readChar() throws EOFException, IOException; char readChar() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a signed 16-bit value into a Java in from the stream. * This method reads a signed 16-bit value into a Java in from the stream.
* It operates by reading two bytes from the stream and converting them to * It operates by reading two bytes from the stream and converting them to
* a single 16-bit Java <code>short</code>. The two bytes are stored most * a single 16-bit Java <code>short</code>. The two bytes are stored most
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> and <code>byte2</code> represent the * As an example, if <code>byte1</code> and <code>byte2</code> represent the
* first and second byte read from the stream respectively, they will be * first and second byte read from the stream respectively, they will be
* transformed to a <code>short</code> in the following manner: * transformed to a <code>short</code> in the following manner:
* <p> * <p>
* <code>(short)((byte1 << 8) + byte2)</code> * <code>(short)((byte1 << 8) + byte2)</code>
* <p> * <p>
* The value returned is in the range of -32768 to 32767. * The value returned is in the range of -32768 to 32767.
* <p> * <p>
* This method can read a <code>short</code> written by an object * This method can read a <code>short</code> written by an object
* implementing * implementing
* the <code>writeShort()</code> method in the <code>DataOutput</code> * the <code>writeShort()</code> method in the <code>DataOutput</code>
* interface. * interface.
* *
* @return The <code>short</code> value read * @return The <code>short</code> value read
* *
* @exception EOFException If end of file is reached before reading the value * @exception EOFException If end of file is reached before reading the value
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
short readShort() throws EOFException, IOException; short readShort() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads 16 unsigned bits into a Java int value from the stream. * This method reads 16 unsigned bits into a Java int value from the stream.
* It operates by reading two bytes from the stream and converting them to * It operates by reading two bytes from the stream and converting them to
* a single Java <code>int</code>. The two bytes are stored most * a single Java <code>int</code>. The two bytes are stored most
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> and <code>byte2</code> represent the * As an example, if <code>byte1</code> and <code>byte2</code> represent the
* first and second byte read from the stream respectively, they will be * first and second byte read from the stream respectively, they will be
* transformed to an <code>int</code> in the following manner: * transformed to an <code>int</code> in the following manner:
* <p> * <p>
* <code>(int)((byte1 << 8) + byte2)</code> * <code>(int)((byte1 << 8) + byte2)</code>
* <p> * <p>
* The value returned is in the range of 0 to 65535. * The value returned is in the range of 0 to 65535.
* <p> * <p>
* This method can read an unsigned short written by an object implementing * This method can read an unsigned short written by an object implementing
* the <code>writeUnsignedShort()</code> method in the * the <code>writeUnsignedShort()</code> method in the
* <code>DataOutput</code> * <code>DataOutput</code>
* interface. * interface.
* *
* @return The unsigned short value read as a Java <code>int</code>. * @return The unsigned short value read as a Java <code>int</code>.
* *
* @exception EOFException If end of file is reached before reading * @exception EOFException If end of file is reached before reading
* the value * the value
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
int readUnsignedShort() throws EOFException, IOException; int readUnsignedShort() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java <code>int</code> value from an input stream * This method reads a Java <code>int</code> value from an input stream
* It operates by reading four bytes from the stream and converting them to * It operates by reading four bytes from the stream and converting them to
* a single Java <code>int</code>. The bytes are stored most * a single Java <code>int</code>. The bytes are stored most
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> through <code>byte4</code> represent * As an example, if <code>byte1</code> through <code>byte4</code> represent
* the first four bytes read from the stream, they will be * the first four bytes read from the stream, they will be
* transformed to an <code>int</code> in the following manner: * transformed to an <code>int</code> in the following manner:
* <p> * <p>
* <code>(int)((byte1 << 24) + (byte2 << 16) + (byte3 << 8) + byte4))</code> * <code>(int)((byte1 << 24) + (byte2 << 16) + (byte3 << 8) + byte4))</code>
* <p> * <p>
* The value returned is in the range of -2147483648 to 2147483647. * The value returned is in the range of -2147483648 to 2147483647.
* <p> * <p>
* This method can read an <code>int</code> written by an object * This method can read an <code>int</code> written by an object
* implementing the <code>writeInt()</code> method in the * implementing the <code>writeInt()</code> method in the
* <code>DataOutput</code> interface. * <code>DataOutput</code> interface.
* *
* @return The <code>int</code> value read * @return The <code>int</code> value read
* *
* @exception EOFException If end of file is reached before reading the int * @exception EOFException If end of file is reached before reading the int
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
int readInt() throws EOFException, IOException; int readInt() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java <code>long</code> value from an input stream * This method reads a Java <code>long</code> value from an input stream
* It operates by reading eight bytes from the stream and converting them to * It operates by reading eight bytes from the stream and converting them to
* a single Java <code>long</code>. The bytes are stored most * a single Java <code>long</code>. The bytes are stored most
* significant byte first (i.e., "big endian") regardless of the native * significant byte first (i.e., "big endian") regardless of the native
* host byte ordering. * host byte ordering.
* <p> * <p>
* As an example, if <code>byte1</code> through <code>byte8</code> represent * As an example, if <code>byte1</code> through <code>byte8</code> represent
* the first eight bytes read from the stream, they will be * the first eight bytes read from the stream, they will be
* transformed to an <code>long</code> in the following manner: * transformed to an <code>long</code> in the following manner:
* <p> * <p>
* <code>(long)((byte1 << 56) + (byte2 << 48) + (byte3 << 40) + * <code>(long)((byte1 << 56) + (byte2 << 48) + (byte3 << 40) +
* (byte4 << 32) + (byte5 << 24) + (byte6 << 16) + (byte7 << 8) + byte9)) * (byte4 << 32) + (byte5 << 24) + (byte6 << 16) + (byte7 << 8) + byte9))
* </code> * </code>
* <p> * <p>
* The value returned is in the range of -9223372036854775808 to * The value returned is in the range of -9223372036854775808 to
* 9223372036854775807. * 9223372036854775807.
* <p> * <p>
* This method can read an <code>long</code> written by an object * This method can read an <code>long</code> written by an object
* implementing the <code>writeLong()</code> method in the * implementing the <code>writeLong()</code> method in the
* <code>DataOutput</code> interface. * <code>DataOutput</code> interface.
* *
* @return The <code>long</code> value read * @return The <code>long</code> value read
* *
* @exception EOFException If end of file is reached before reading the long * @exception EOFException If end of file is reached before reading the long
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
long readLong() throws EOFException, IOException; long readLong() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java float value from an input stream. It operates * This method reads a Java float value from an input stream. It operates
* by first reading an <code>int</code> value from the stream by calling the * by first reading an <code>int</code> value from the stream by calling the
* <code>readInt()</code> method in this interface, then converts that * <code>readInt()</code> method in this interface, then converts that
* <code>int</code> to a <code>float</code> using the * <code>int</code> to a <code>float</code> using the
* <code>intBitsToFloat</code> method in the class * <code>intBitsToFloat</code> method in the class
* <code>java.lang.Float</code>. * <code>java.lang.Float</code>.
* <p> * <p>
* This method can read a <code>float</code> written by an object * This method can read a <code>float</code> written by an object
* implementing * implementing
* the <code>writeFloat()</code> method in the <code>DataOutput</code> * the <code>writeFloat()</code> method in the <code>DataOutput</code>
* interface. * interface.
* *
* @return The <code>float</code> value read * @return The <code>float</code> value read
* *
* @exception EOFException If end of file is reached before reading the * @exception EOFException If end of file is reached before reading the
* float * float
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see java.lang.Float * @see java.lang.Float
* @see DataOutput * @see DataOutput
*/ */
float readFloat() throws EOFException, IOException; float readFloat() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads a Java double value from an input stream. It operates * This method reads a Java double value from an input stream. It operates
* by first reading a <code>long</code> value from the stream by calling the * by first reading a <code>long</code> value from the stream by calling the
* <code>readLong()</code> method in this interface, then converts that * <code>readLong()</code> method in this interface, then converts that
* <code>long</code> to a <code>double</code> using the * <code>long</code> to a <code>double</code> using the
* <code>longBitsToDouble</code> method in the class * <code>longBitsToDouble</code> method in the class
* <code>java.lang.Double</code>. * <code>java.lang.Double</code>.
* <p> * <p>
* This method can read a <code>double</code> written by an object * This method can read a <code>double</code> written by an object
* implementing the <code>writeDouble()</code> method in the * implementing the <code>writeDouble()</code> method in the
* <code>DataOutput</code> interface. * <code>DataOutput</code> interface.
* *
* @return The <code>double</code> value read * @return The <code>double</code> value read
* *
* @exception EOFException If end of file is reached before reading the * @exception EOFException If end of file is reached before reading the
* double * double
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see java.lang.Double * @see java.lang.Double
* @see DataOutput * @see DataOutput
*/ */
double readDouble() throws EOFException, IOException; double readDouble() throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads the next line of text data from an input stream. * This method reads the next line of text data from an input stream.
* It operates by reading bytes and converting those bytes to * It operates by reading bytes and converting those bytes to
* <code>char</code> * <code>char</code>
* values by treating the byte read as the low eight bits of the * values by treating the byte read as the low eight bits of the
* <code>char</code> and using 0 as the high eight bits. Because of this, * <code>char</code> and using 0 as the high eight bits. Because of this,
* it does not support the full 16-bit Unicode character set. * it does not support the full 16-bit Unicode character set.
* <P> * <P>
* The reading of bytes ends when either the end of file or a line terminator * The reading of bytes ends when either the end of file or a line terminator
* is encountered. The bytes read are then returned as a * is encountered. The bytes read are then returned as a
* <code>String</code>. * <code>String</code>.
* A line terminator is a byte sequence consisting of either * A line terminator is a byte sequence consisting of either
* <code>\r</code>, <code>\n</code> or <code>\r\n</code>. These termination * <code>\r</code>, <code>\n</code> or <code>\r\n</code>. These termination
* charaters are discarded and are not returned as part of the string. * charaters are discarded and are not returned as part of the string.
* <p> * <p>
* This method can read data that was written by an object implementing the * This method can read data that was written by an object implementing the
* <code>writeLine()</code> method in <code>DataOutput</code>. * <code>writeLine()</code> method in <code>DataOutput</code>.
* *
* @return The line read as a <code>String</code> * @return The line read as a <code>String</code>
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
String readLine() throws IOException; String readLine() throws IOException;
/*************************************************************************/
/** /**
* This method reads a <code>String</code> from an input stream that is * This method reads a <code>String</code> from an input stream that is
* encoded in a modified UTF-8 format. This format has a leading two byte * encoded in a modified UTF-8 format. This format has a leading two byte
* sequence that contains the remaining number of bytes to read. * sequence that contains the remaining number of bytes to read.
* This two byte * This two byte
* sequence is read using the <code>readUnsignedShort()</code> method of this * sequence is read using the <code>readUnsignedShort()</code> method of this
* interface. * interface.
* *
* After the number of remaining bytes have been determined, these bytes * After the number of remaining bytes have been determined, these bytes
* are read an transformed into <code>char</code> values. These * are read an transformed into <code>char</code> values. These
* <code>char</code> values are encoded in the stream using either a one, * <code>char</code> values are encoded in the stream using either a one,
* two, or three byte format. * two, or three byte format.
* The particular format in use can be determined by examining the first * The particular format in use can be determined by examining the first
* byte read. * byte read.
* <p> * <p>
* If the first byte has a high order bit of 0, then * If the first byte has a high order bit of 0, then
* that character consists on only one byte. This character value consists * that character consists on only one byte. This character value consists
* of seven bits that are at positions 0 through 6 of the byte. As an * of seven bits that are at positions 0 through 6 of the byte. As an
* example, if <code>byte1</code> is the byte read from the stream, it would * example, if <code>byte1</code> is the byte read from the stream, it would
* be converted to a <code>char</code> like so: * be converted to a <code>char</code> like so:
* <p> * <p>
* <code>(char)byte1</code> * <code>(char)byte1</code>
* <p> * <p>
* If the first byte has 110 as its high order bits, then the * If the first byte has 110 as its high order bits, then the
* character consists of two bytes. The bits that make up the character * character consists of two bytes. The bits that make up the character
* value are in positions 0 through 4 of the first byte and bit positions * value are in positions 0 through 4 of the first byte and bit positions
* 0 through 5 of the second byte. (The second byte should have * 0 through 5 of the second byte. (The second byte should have
* 10 as its high order bits). These values are in most significant * 10 as its high order bits). These values are in most significant
* byte first (i.e., "big endian") order. * byte first (i.e., "big endian") order.
* <p> * <p>
* As an example, if <code>byte1</code> and <code>byte2</code> are the first * As an example, if <code>byte1</code> and <code>byte2</code> are the first
* two bytes read respectively, and the high order bits of them match the * two bytes read respectively, and the high order bits of them match the
* patterns which indicate a two byte character encoding, then they would be * patterns which indicate a two byte character encoding, then they would be
* converted to a Java <code>char</code> like so: * converted to a Java <code>char</code> like so:
* <p> * <p>
* <code>(char)(((byte1 & 0x1F) << 6) + (byte2 & 0x3F))</code> * <code>(char)(((byte1 & 0x1F) << 6) + (byte2 & 0x3F))</code>
* <p> * <p>
* If the first byte has a 1110 as its high order bits, then the * If the first byte has a 1110 as its high order bits, then the
* character consists of three bytes. The bits that make up the character * character consists of three bytes. The bits that make up the character
* value are in positions 0 through 3 of the first byte and bit positions * value are in positions 0 through 3 of the first byte and bit positions
* 0 through 5 of the other two bytes. (The second and third bytes should * 0 through 5 of the other two bytes. (The second and third bytes should
* have 10 as their high order bits). These values are in most * have 10 as their high order bits). These values are in most
* significant byte first (i.e., "big endian") order. * significant byte first (i.e., "big endian") order.
* <p> * <p>
* As an example, if <code>byte1</code>, <code>byte2</code>, and * As an example, if <code>byte1</code>, <code>byte2</code>, and
* <code>byte3</code> are the three bytes read, and the high order bits of * <code>byte3</code> are the three bytes read, and the high order bits of
* them match the patterns which indicate a three byte character encoding, * them match the patterns which indicate a three byte character encoding,
* then they would be converted to a Java <code>char</code> like so: * then they would be converted to a Java <code>char</code> like so:
* *
* <code> * <code>
* (char)(((byte1 & 0x0F) << 12) + ((byte2 & 0x3F) + (byte3 & 0x3F)) * (char)(((byte1 & 0x0F) << 12) + ((byte2 & 0x3F) + (byte3 & 0x3F))
* </code> * </code>
* *
* Note that all characters are encoded in the method that requires the * Note that all characters are encoded in the method that requires the
* fewest number of bytes with the exception of the character with the * fewest number of bytes with the exception of the character with the
* value of <code>\<llll>u0000</code> which is encoded as two bytes. * value of <code>\<llll>u0000</code> which is encoded as two bytes.
* This is a modification of the UTF standard used to prevent C language * This is a modification of the UTF standard used to prevent C language
* style <code>NUL</code> values from appearing in the byte stream. * style <code>NUL</code> values from appearing in the byte stream.
* <p> * <p>
* This method can read data that was written by an object implementing the * This method can read data that was written by an object implementing the
* <code>writeUTF()</code> method in <code>DataOutput</code>. * <code>writeUTF()</code> method in <code>DataOutput</code>.
* *
* @returns The <code>String</code> read * @returns The <code>String</code> read
* *
* @exception EOFException If end of file is reached before reading the * @exception EOFException If end of file is reached before reading the
* String * String
* @exception UTFDataFormatException If the data is not in UTF-8 format * @exception UTFDataFormatException If the data is not in UTF-8 format
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
* *
* @see DataOutput * @see DataOutput
*/ */
String readUTF() throws EOFException, UTFDataFormatException, IOException; String readUTF() throws EOFException, UTFDataFormatException, IOException;
/*************************************************************************/
/** /**
* This method reads raw bytes into the passed array until the array is * This method reads raw bytes into the passed array until the array is
* full. Note that this method blocks until the data is available and * full. Note that this method blocks until the data is available and
* throws an exception if there is not enough data left in the stream to * throws an exception if there is not enough data left in the stream to
* fill the buffer * fill the buffer
* *
* @param buf The buffer into which to read the data * @param buf The buffer into which to read the data
* *
* @exception EOFException If end of file is reached before filling the * @exception EOFException If end of file is reached before filling the
* buffer * buffer
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
void readFully(byte[] buf) throws EOFException, IOException; void readFully(byte[] buf) throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method reads raw bytes into the passed array <code>buf</code> * This method reads raw bytes into the passed array <code>buf</code>
* starting * starting
* <code>offset</code> bytes into the buffer. The number of bytes read * <code>offset</code> bytes into the buffer. The number of bytes read
* will be * will be
* exactly <code>len</code>. Note that this method blocks until the data is * exactly <code>len</code>. Note that this method blocks until the data is
* available and * throws an exception if there is not enough data left in * available and * throws an exception if there is not enough data left in
* the stream to read <code>len</code> bytes. * the stream to read <code>len</code> bytes.
* *
* @param buf The buffer into which to read the data * @param buf The buffer into which to read the data
* @param offset The offset into the buffer to start storing data * @param offset The offset into the buffer to start storing data
* @param len The number of bytes to read into the buffer * @param len The number of bytes to read into the buffer
* *
* @exception EOFException If end of file is reached before filling the * @exception EOFException If end of file is reached before filling the
* buffer * buffer
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
void readFully(byte[] buf, int offset, int len) void readFully(byte[] buf, int offset, int len)
throws EOFException, IOException; throws EOFException, IOException;
/*************************************************************************/
/** /**
* This method skips and discards the specified number of bytes in an * This method skips and discards the specified number of bytes in an
* input stream * input stream
* *
* @param num_bytes The number of bytes to skip * @param num_bytes The number of bytes to skip
* *
* @return The number of bytes actually skipped, which will always be * @return The number of bytes actually skipped, which will always be
* <code>num_bytes</code> * <code>num_bytes</code>
* *
* @exception EOFException If end of file is reached before all bytes can be * @exception EOFException If end of file is reached before all bytes can be
* skipped * skipped
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
int skipBytes(int n) throws EOFException, IOException; int skipBytes(int n) throws EOFException, IOException;
} // interface DataInput } // interface DataInput
libjava/java/io/DataOutput.java
...@@ -44,173 +44,147 @@ package java.io; ...@@ -44,173 +44,147 @@ package java.io;
*/ */
/** /**
* This interface is implemented by classes that can wrte data to streams * This interface is implemented by classes that can wrte data to streams
* from Java primitive types. * from Java primitive types.
* *
* @author Aaron M. Renn (arenn@urbanophile.com) * @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com> * @author Tom Tromey <tromey@cygnus.com>
*/ */
public interface DataOutput public interface DataOutput
{ {
/** /**
* This method writes a Java boolean value to an output stream * This method writes a Java boolean value to an output stream
* *
* @param value The boolean value to write * @param value The boolean value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeBoolean(boolean value) throws IOException; void writeBoolean(boolean value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java byte value to an output stream * This method writes a Java byte value to an output stream
* *
* @param value The int value to write * @param value The int value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeByte(int value) throws IOException; void writeByte(int value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java char value to an output stream * This method writes a Java char value to an output stream
* *
* @param value The char value to write * @param value The char value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeChar(int value) throws IOException; void writeChar(int value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java int value to an output stream as a 16 bit value * 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 * @param value The int value to write as a 16-bit value
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeShort(int value) throws IOException; void writeShort(int value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java int value to an output stream * This method writes a Java int value to an output stream
* *
* @param value The int value to write * @param value The int value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeInt(int value) throws IOException; void writeInt(int value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java long value to an output stream * This method writes a Java long value to an output stream
* *
* @param value The long value to write * @param value The long value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeLong(long value) throws IOException; void writeLong(long value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java float value to an output stream * This method writes a Java float value to an output stream
* *
* @param value The float value to write * @param value The float value to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeFloat(float value) throws IOException; void writeFloat(float value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a Java double value to an output stream * This method writes a Java double value to an output stream
* *
* @param value The double value to write * @param value The double value to write
* *
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
void writeDouble(double value) throws IOException; void writeDouble(double value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a String to an output stream as an array of bytes * This method writes a String to an output stream as an array of bytes
* *
* @param value The String to write * @param value The String to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeBytes(String value) throws IOException; void writeBytes(String value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a String to an output stream as an array of char's * This method writes a String to an output stream as an array of char's
* *
* @param value The String to write * @param value The String to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeChars(String value) throws IOException; void writeChars(String value) throws IOException;
/*************************************************************************/
/** /**
* This method writes a String to an output stream encoded in * This method writes a String to an output stream encoded in
* UTF-8 format. * UTF-8 format.
* *
* @param value The String to write * @param value The String to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void writeUTF(String value) throws IOException; void writeUTF(String value) throws IOException;
/*************************************************************************/
/** /**
* This method writes an 8-bit value (passed into the method as a Java * This method writes an 8-bit value (passed into the method as a Java
* int) to an output stream. * int) to an output stream.
* *
* @param value The byte to write to the output stream * @param value The byte to write to the output stream
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void write(int value) throws IOException; void write(int value) throws IOException;
/*************************************************************************/
/** /**
* This method writes the raw byte array passed in to the output stream. * This method writes the raw byte array passed in to the output stream.
* *
* @param buf The byte array to write * @param buf The byte array to write
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
void write(byte[] buf) throws IOException; void write(byte[] buf) throws IOException;
/*************************************************************************/
/** /**
* This method writes raw bytes from the passed array <code>buf</code> * This method writes raw bytes from the passed array <code>buf</code>
* starting * starting
* <code>offset</code> bytes into the buffer. The number of bytes * <code>offset</code> bytes into the buffer. The number of bytes
* written will be * exactly <code>len</code>. * written will be * exactly <code>len</code>.
* *
* @param buf The buffer from which to write the data * @param buf The buffer from which to write the data
* @param offset The offset into the buffer to start writing data from * @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 * @param len The number of bytes to write from the buffer to the output
* stream * stream
* *
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
void write(byte[] buf, int offset, int len) throws IOException; void write(byte[] buf, int offset, int len) throws IOException;
} // interface DataOutput } // interface DataOutput
......
libjava/java/io/DataOutputStream.java
/* DataOutputStream.java -- Writes primitive Java datatypes to streams /* 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. This file is part of GNU Classpath.
......
libjava/java/io/Externalizable.java
...@@ -39,74 +39,72 @@ exception statement from your version. */ ...@@ -39,74 +39,72 @@ exception statement from your version. */
package java.io; package java.io;
/** /**
* This interface provides a way that classes can completely control how * This interface provides a way that classes can completely control how
* the data of their object instances are written and read to and from * 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 * 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 * 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. * in exactly the way it was written by the write method.
* <p> * <p>
* Note that classes which implement this interface must take into account * Note that classes which implement this interface must take into account
* that all superclass data must also be written to the stream as well. * 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 * The class implementing this interface must figure out how to make that
* happen. * happen.
* <p> * <p>
* This interface can be used to provide object persistence. When an * This interface can be used to provide object persistence. When an
* object is to be stored externally, the <code>writeExternal</code> method is * object is to be stored externally, the <code>writeExternal</code> method is
* called to save state. When the object is restored, an instance is * called to save state. When the object is restored, an instance is
* created using the default no-argument constructor and the * created using the default no-argument constructor and the
* <code>readExternal</code> method is used to restore the state. * <code>readExternal</code> method is used to restore the state.
* *
* @author Aaron M. Renn (arenn@urbanophile.com) * @author Aaron M. Renn (arenn@urbanophile.com)
*/ */
public interface Externalizable extends Serializable public interface Externalizable extends Serializable
{ {
static final long serialVersionUID = -282491828744381764L; static final long serialVersionUID = -282491828744381764L;
/** /**
* This method restores an object's state by reading in the instance data * 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 * 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 * a subclass of <code>InputStream</code>, but rather is a class that
* implements * implements
* the <code>ObjectInput</code> interface. That interface provides a * the <code>ObjectInput</code> interface. That interface provides a
* mechanism for * mechanism for
* reading in Java data types from a stream. * reading in Java data types from a stream.
* <p> * <p>
* Note that this method must be compatible with <code>writeExternal</code>. * Note that this method must be compatible with <code>writeExternal</code>.
* It must read back the exact same types that were written by that * It must read back the exact same types that were written by that
* method in the exact order they were written. * method in the exact order they were written.
* <p> * <p>
* If this method needs to read back an object instance, then the class * 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, * for that object must be found and loaded. If that operation fails,
* then this method throws a <code>ClassNotFoundException</code> * then this method throws a <code>ClassNotFoundException</code>
* *
* @param in An <code>ObjectInput</code> instance for reading in the object * @param in An <code>ObjectInput</code> instance for reading in the object
* state * state
* *
* @exception ClassNotFoundException If the class of an object being * @exception ClassNotFoundException If the class of an object being
* restored cannot be found * restored cannot be found
* @exception IOException If any other error occurs * @exception IOException If any other error occurs
*/ */
public abstract void readExternal(ObjectInput in) public abstract void readExternal(ObjectInput in)
throws ClassNotFoundException, IOException; throws ClassNotFoundException, IOException;
/*************************************************************************/
/** /**
* This method is responsible for writing the instance data of an object * 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 * 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>OutputStream</code>, but rather is a class that implements the
* <code>ObjectOutput</code> interface. That interface provides a * <code>ObjectOutput</code> interface. That interface provides a
* number of methods * number of methods
* for writing Java data values to a stream. * for writing Java data values to a stream.
* <p> * <p>
* Not that the implementation of this method must be coordinated with * Not that the implementation of this method must be coordinated with
* the implementation of <code>readExternal</code>. * the implementation of <code>readExternal</code>.
* *
* @param out An <code>ObjectOutput</code> instance for writing the * @param out An <code>ObjectOutput</code> instance for writing the
* object state * object state
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public abstract void writeExternal(ObjectOutput out) throws IOException; public abstract void writeExternal(ObjectOutput out) throws IOException;
} // interface Externalizable } // interface Externalizable
......
libjava/java/io/FileFilter.java
...@@ -39,27 +39,27 @@ exception statement from your version. */ ...@@ -39,27 +39,27 @@ exception statement from your version. */
package java.io; package java.io;
/** /**
* This interface has one method which is used for filtering pathnames * This interface has one method which is used for filtering pathnames
* returned in a pathname listing. It is currently used by the * returned in a pathname listing. It is currently used by the
* <code>File.listFiles()</code> method. * <code>File.listFiles()</code> method.
* <p> * <p>
* The method in this interface determines if a particular pathname should * The method in this interface determines if a particular pathname should
* or should not be included in the pathname listing. * or should not be included in the pathname listing.
* *
* @author Aaron M. Renn (arenn@urbanophile.com) * @author Aaron M. Renn (arenn@urbanophile.com)
*/ */
public interface FileFilter public interface FileFilter
{ {
/** /**
* This method determines whether or not a given pathname should be included * This method determines whether or not a given pathname should be included
* in a pathname listing. * in a pathname listing.
* *
* @param pathname The pathname to test * @param pathname The pathname to test
* *
* @return <code>true</code> if the path should be included in the list, * @return <code>true</code> if the path should be included in the list,
* <code>false</code> otherwise. * <code>false</code> otherwise.
*/ */
public abstract boolean accept(File pathname); public abstract boolean accept(File pathname);
} // interface FileFilter } // interface FileFilter
......
libjava/java/io/FileInputStream.java
/* FileInputStream.java -- An input stream that reads from disk files. /* 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. This file is part of GNU Classpath.
......
libjava/java/io/FileOutputStream.java
/* FileOutputStream.java -- Writes to a file on disk. /* 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. This file is part of GNU Classpath.
......
libjava/java/io/FilePermission.java
...@@ -93,7 +93,7 @@ public final class FilePermission extends Permission implements Serializable ...@@ -93,7 +93,7 @@ public final class FilePermission extends Permission implements Serializable
** permission represents. ** permission represents.
** @param actionsString a comma-separated list of the actions this ** @param actionsString a comma-separated list of the actions this
** permission represents. ** 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) public FilePermission(String pathExpression, String actionsString)
{ {
......
libjava/java/io/FileWriter.java
...@@ -54,8 +54,6 @@ package java.io; ...@@ -54,8 +54,6 @@ package java.io;
public class FileWriter extends OutputStreamWriter public class FileWriter extends OutputStreamWriter
{ {
/*************************************************************************/
/* /*
* Constructors * Constructors
*/ */
...@@ -75,8 +73,6 @@ public class FileWriter extends OutputStreamWriter ...@@ -75,8 +73,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(file)); super(new FileOutputStream(file));
} }
/*************************************************************************/
/** /**
* This method initializes a new <code>FileWriter</code> object to write * This method initializes a new <code>FileWriter</code> object to write
* to the specified <code>File</code> object. * to the specified <code>File</code> object.
...@@ -94,8 +90,6 @@ public class FileWriter extends OutputStreamWriter ...@@ -94,8 +90,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(file, append)); super(new FileOutputStream(file, append));
} }
/*************************************************************************/
/** /**
* This method initializes a new <code>FileWriter</code> object to write * This method initializes a new <code>FileWriter</code> object to write
* to the specified <code>FileDescriptor</code> object. * to the specified <code>FileDescriptor</code> object.
...@@ -110,8 +104,6 @@ public class FileWriter extends OutputStreamWriter ...@@ -110,8 +104,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(fd)); super(new FileOutputStream(fd));
} }
/*************************************************************************/
/** /**
* This method intializes a new <code>FileWriter</code> object to * This method intializes a new <code>FileWriter</code> object to
* write to the * write to the
...@@ -128,8 +120,6 @@ public class FileWriter extends OutputStreamWriter ...@@ -128,8 +120,6 @@ public class FileWriter extends OutputStreamWriter
super(new FileOutputStream(name)); super(new FileOutputStream(name));
} }
/*************************************************************************/
/** /**
* This method intializes a new <code>FileWriter</code> object to * This method intializes a new <code>FileWriter</code> object to
* write to the * write to the
......
libjava/java/io/FilenameFilter.java
...@@ -44,29 +44,29 @@ package java.io; ...@@ -44,29 +44,29 @@ package java.io;
*/ */
/** /**
* This interface has one method which is used for filtering filenames * This interface has one method which is used for filtering filenames
* returned in a directory listing. It is currently used by the * returned in a directory listing. It is currently used by the
* <code>File.list()</code> method and by the filename dialog in AWT. * <code>File.list()</code> method and by the filename dialog in AWT.
* <p> * <p>
* The method in this interface determines if a particular file should * The method in this interface determines if a particular file should
* or should not be included in the file listing. * or should not be included in the file listing.
* *
* @author Aaron M. Renn (arenn@urbanophile.com) * @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey <tromey@cygnus.com> * @author Tom Tromey <tromey@cygnus.com>
*/ */
public interface FilenameFilter public interface FilenameFilter
{ {
/** /**
* This method determines whether or not a given file should be included * This method determines whether or not a given file should be included
* in a directory listing. * in a directory listing.
* *
* @param dir The <code>File</code> instance for the directory being read * @param dir The <code>File</code> instance for the directory being read
* @param name The name of the file to test * @param name The name of the file to test
* *
* @return <code>true</code> if the file should be included in the list, * @return <code>true</code> if the file should be included in the list,
* <code>false</code> otherwise. * <code>false</code> otherwise.
*/ */
boolean accept(File dir, String name); boolean accept(File dir, String name);
} // interface FilenameFilter } // interface FilenameFilter
......
libjava/java/io/FilterInputStream.java
...@@ -69,25 +69,12 @@ package java.io; ...@@ -69,25 +69,12 @@ package java.io;
*/ */
public class FilterInputStream extends InputStream public class FilterInputStream extends InputStream
{ {
/*************************************************************************/
/*
* Instance Variables
*/
/** /**
* This is the subordinate <code>InputStream</code> to which method calls * This is the subordinate <code>InputStream</code> to which method calls
* are redirected * are redirected
*/ */
protected InputStream in; protected InputStream in;
/*************************************************************************/
/*
* Constructors
*/
/** /**
* Create a <code>FilterInputStream</code> with the specified subordinate * Create a <code>FilterInputStream</code> with the specified subordinate
* <code>InputStream</code>. * <code>InputStream</code>.
...@@ -99,12 +86,6 @@ public class FilterInputStream extends InputStream ...@@ -99,12 +86,6 @@ public class FilterInputStream extends InputStream
this.in = in; this.in = in;
} }
/*************************************************************************/
/*
* Instance Methods
*/
/** /**
* Calls the <code>in.mark(int)</code> method. * Calls the <code>in.mark(int)</code> method.
* *
...@@ -115,8 +96,6 @@ public class FilterInputStream extends InputStream ...@@ -115,8 +96,6 @@ public class FilterInputStream extends InputStream
in.mark(readlimit); in.mark(readlimit);
} }
/*************************************************************************/
/** /**
* Calls the <code>in.markSupported()</code> method. * Calls the <code>in.markSupported()</code> method.
* *
...@@ -128,8 +107,6 @@ public class FilterInputStream extends InputStream ...@@ -128,8 +107,6 @@ public class FilterInputStream extends InputStream
return(in.markSupported()); return(in.markSupported());
} }
/*************************************************************************/
/** /**
* Calls the <code>in.reset()</code> method. * Calls the <code>in.reset()</code> method.
* *
...@@ -140,8 +117,6 @@ public class FilterInputStream extends InputStream ...@@ -140,8 +117,6 @@ public class FilterInputStream extends InputStream
in.reset(); in.reset();
} }
/*************************************************************************/
/** /**
* Calls the <code>in.available()</code> method. * Calls the <code>in.available()</code> method.
* *
...@@ -154,8 +129,6 @@ public class FilterInputStream extends InputStream ...@@ -154,8 +129,6 @@ public class FilterInputStream extends InputStream
return(in.available()); return(in.available());
} }
/*************************************************************************/
/** /**
* Calls the <code>in.skip(long)</code> method * Calls the <code>in.skip(long)</code> method
* *
...@@ -170,8 +143,6 @@ public class FilterInputStream extends InputStream ...@@ -170,8 +143,6 @@ public class FilterInputStream extends InputStream
return(in.skip(num_bytes)); return(in.skip(num_bytes));
} }
/*************************************************************************/
/** /**
* Calls the <code>in.read()</code> method * Calls the <code>in.read()</code> method
* *
...@@ -184,8 +155,6 @@ public class FilterInputStream extends InputStream ...@@ -184,8 +155,6 @@ public class FilterInputStream extends InputStream
return(in.read()); return(in.read());
} }
/*************************************************************************/
/** /**
* Calls the <code>read(byte[], int, int)</code> overloaded method. * Calls the <code>read(byte[], int, int)</code> overloaded method.
* Note that * Note that
...@@ -204,8 +173,6 @@ public class FilterInputStream extends InputStream ...@@ -204,8 +173,6 @@ public class FilterInputStream extends InputStream
return(read(buf, 0, buf.length)); return(read(buf, 0, buf.length));
} }
/*************************************************************************/
/** /**
* Calls the <code>in.read(byte[], int, int)</code> method. * Calls the <code>in.read(byte[], int, int)</code> method.
* *
...@@ -222,8 +189,6 @@ public class FilterInputStream extends InputStream ...@@ -222,8 +189,6 @@ public class FilterInputStream extends InputStream
return(in.read(buf, offset, len)); return(in.read(buf, offset, len));
} }
/*************************************************************************/
/** /**
* This method closes the input stream by closing the input stream that * This method closes the input stream by closing the input stream that
* this object is filtering. Future attempts to access this stream may * this object is filtering. Future attempts to access this stream may
......
libjava/java/io/FilterOutputStream.java
...@@ -56,25 +56,12 @@ package java.io; ...@@ -56,25 +56,12 @@ package java.io;
*/ */
public class FilterOutputStream extends OutputStream public class FilterOutputStream extends OutputStream
{ {
/*************************************************************************/
/*
* Instance Variables
*/
/** /**
* This is the subordinate <code>OutputStream</code> that this class * This is the subordinate <code>OutputStream</code> that this class
* redirects its method calls to. * redirects its method calls to.
*/ */
protected OutputStream out; protected OutputStream out;
/*************************************************************************/
/*
* Constructors
*/
/** /**
* This method initializes an instance of <code>FilterOutputStream</code> * This method initializes an instance of <code>FilterOutputStream</code>
* to write to the specified subordinate <code>OutputStream</code>. * to write to the specified subordinate <code>OutputStream</code>.
...@@ -86,12 +73,6 @@ public class FilterOutputStream extends OutputStream ...@@ -86,12 +73,6 @@ public class FilterOutputStream extends OutputStream
this.out = out; this.out = out;
} }
/*************************************************************************/
/*
* Instance Methods
*/
/** /**
* This method closes the underlying <code>OutputStream</code>. Any * This method closes the underlying <code>OutputStream</code>. Any
* further attempts to write to this stream may throw an exception. * further attempts to write to this stream may throw an exception.
...@@ -104,8 +85,6 @@ public class FilterOutputStream extends OutputStream ...@@ -104,8 +85,6 @@ public class FilterOutputStream extends OutputStream
out.close(); out.close();
} }
/*************************************************************************/
/** /**
* This method attempt to flush all buffered output to be written to the * This method attempt to flush all buffered output to be written to the
* underlying output sink. * underlying output sink.
...@@ -117,8 +96,6 @@ public class FilterOutputStream extends OutputStream ...@@ -117,8 +96,6 @@ public class FilterOutputStream extends OutputStream
out.flush(); out.flush();
} }
/*************************************************************************/
/** /**
* This method writes a single byte of output to the underlying * This method writes a single byte of output to the underlying
* <code>OutputStream</code>. * <code>OutputStream</code>.
...@@ -132,8 +109,6 @@ public class FilterOutputStream extends OutputStream ...@@ -132,8 +109,6 @@ public class FilterOutputStream extends OutputStream
out.write(b); out.write(b);
} }
/*************************************************************************/
/** /**
* This method writes all the bytes in the specified array to the underlying * This method writes all the bytes in the specified array to the underlying
* <code>OutputStream</code>. It does this by calling the three parameter * <code>OutputStream</code>. It does this by calling the three parameter
...@@ -151,8 +126,6 @@ public class FilterOutputStream extends OutputStream ...@@ -151,8 +126,6 @@ public class FilterOutputStream extends OutputStream
write(buf, 0, buf.length); write(buf, 0, buf.length);
} }
/*************************************************************************/
/** /**
* This method calls the <code>write(int)</code> method <code>len</code> * 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 * times for all bytes from the array <code>buf</code> starting at index
......
libjava/java/io/FilterReader.java
...@@ -63,22 +63,12 @@ package java.io; ...@@ -63,22 +63,12 @@ package java.io;
*/ */
public abstract class FilterReader extends Reader public abstract class FilterReader extends Reader
{ {
/*
* Instance Variables
*/
/** /**
* This is the subordinate <code>Reader</code> to which method calls * This is the subordinate <code>Reader</code> to which method calls
* are redirected * are redirected
*/ */
protected Reader in; protected Reader in;
/*************************************************************************/
/*
* Constructors
*/
/** /**
* Create a <code>FilterReader</code> with the specified subordinate * Create a <code>FilterReader</code> with the specified subordinate
* <code>Reader</code>. * <code>Reader</code>.
...@@ -93,12 +83,6 @@ public abstract class FilterReader extends Reader ...@@ -93,12 +83,6 @@ public abstract class FilterReader extends Reader
this.in = in; this.in = in;
} }
/*************************************************************************/
/*
* Instance Methods
*/
/** /**
* Calls the <code>in.mark(int)</code> method. * Calls the <code>in.mark(int)</code> method.
* *
...@@ -111,8 +95,6 @@ public abstract class FilterReader extends Reader ...@@ -111,8 +95,6 @@ public abstract class FilterReader extends Reader
in.mark(readlimit); in.mark(readlimit);
} }
/*************************************************************************/
/** /**
* Calls the <code>in.markSupported()</code> method. * Calls the <code>in.markSupported()</code> method.
* *
...@@ -124,8 +106,6 @@ public abstract class FilterReader extends Reader ...@@ -124,8 +106,6 @@ public abstract class FilterReader extends Reader
return(in.markSupported()); return(in.markSupported());
} }
/*************************************************************************/
/** /**
* Calls the <code>in.reset()</code> method. * Calls the <code>in.reset()</code> method.
* *
...@@ -136,8 +116,6 @@ public abstract class FilterReader extends Reader ...@@ -136,8 +116,6 @@ public abstract class FilterReader extends Reader
in.reset(); in.reset();
} }
/*************************************************************************/
/** /**
* Calls the <code>in.read()</code> method. * Calls the <code>in.read()</code> method.
* *
...@@ -150,8 +128,6 @@ public abstract class FilterReader extends Reader ...@@ -150,8 +128,6 @@ public abstract class FilterReader extends Reader
return(in.ready()); return(in.ready());
} }
/*************************************************************************/
/** /**
* Calls the <code>in.skip(long)</code> method * Calls the <code>in.skip(long)</code> method
* *
...@@ -166,8 +142,6 @@ public abstract class FilterReader extends Reader ...@@ -166,8 +142,6 @@ public abstract class FilterReader extends Reader
return(in.skip(num_chars)); return(in.skip(num_chars));
} }
/*************************************************************************/
/** /**
* Calls the <code>in.read()</code> method * Calls the <code>in.read()</code> method
* *
...@@ -180,8 +154,6 @@ public abstract class FilterReader extends Reader ...@@ -180,8 +154,6 @@ public abstract class FilterReader extends Reader
return(in.read()); return(in.read());
} }
/*************************************************************************/
/** /**
* Calls the <code>in.read(char[], int, int)</code> method. * Calls the <code>in.read(char[], int, int)</code> method.
* *
...@@ -198,8 +170,6 @@ public abstract class FilterReader extends Reader ...@@ -198,8 +170,6 @@ public abstract class FilterReader extends Reader
return(in.read(buf, offset, len)); return(in.read(buf, offset, len));
} }
/*************************************************************************/
/** /**
* This method closes the stream by calling the <code>close()</code> method * This method closes the stream by calling the <code>close()</code> method
* of the underlying stream. * of the underlying stream.
......
libjava/java/io/FilterWriter.java
...@@ -56,22 +56,12 @@ package java.io; ...@@ -56,22 +56,12 @@ package java.io;
*/ */
public abstract class FilterWriter extends Writer public abstract class FilterWriter extends Writer
{ {
/*
* Instance Variables
*/
/** /**
* This is the subordinate <code>Writer</code> that this class * This is the subordinate <code>Writer</code> that this class
* redirects its method calls to. * redirects its method calls to.
*/ */
protected Writer out; protected Writer out;
/*************************************************************************/
/*
* Constructors
*/
/** /**
* This method initializes an instance of <code>FilterWriter</code> * This method initializes an instance of <code>FilterWriter</code>
* to write to the specified subordinate <code>Writer</code>. * to write to the specified subordinate <code>Writer</code>.
...@@ -86,12 +76,6 @@ public abstract class FilterWriter extends Writer ...@@ -86,12 +76,6 @@ public abstract class FilterWriter extends Writer
this.out = out; this.out = out;
} }
/*************************************************************************/
/*
* Instance Methods
*/
/** /**
* This method closes the underlying <code>Writer</code>. Any * This method closes the underlying <code>Writer</code>. Any
* further attempts to write to this stream may throw an exception. * further attempts to write to this stream may throw an exception.
...@@ -103,8 +87,6 @@ public abstract class FilterWriter extends Writer ...@@ -103,8 +87,6 @@ public abstract class FilterWriter extends Writer
out.close(); out.close();
} }
/*************************************************************************/
/** /**
* This method attempt to flush all buffered output to be written to the * This method attempt to flush all buffered output to be written to the
* underlying output sink. * underlying output sink.
...@@ -116,8 +98,6 @@ public abstract class FilterWriter extends Writer ...@@ -116,8 +98,6 @@ public abstract class FilterWriter extends Writer
out.flush(); out.flush();
} }
/*************************************************************************/
/** /**
* This method writes a single char of output to the underlying * This method writes a single char of output to the underlying
* <code>Writer</code>. * <code>Writer</code>.
...@@ -131,8 +111,6 @@ public abstract class FilterWriter extends Writer ...@@ -131,8 +111,6 @@ public abstract class FilterWriter extends Writer
out.write(b); out.write(b);
} }
/*************************************************************************/
/** /**
* This method writes <code>len</code> chars from the array <code>buf</code> * This method writes <code>len</code> chars from the array <code>buf</code>
* starting at index <code>offset</code> to the underlying * starting at index <code>offset</code> to the underlying
...@@ -149,8 +127,6 @@ public abstract class FilterWriter extends Writer ...@@ -149,8 +127,6 @@ public abstract class FilterWriter extends Writer
out.write(buf, offset, len); out.write(buf, offset, len);
} }
/*************************************************************************/
/** /**
* This method writes <code>len</code> chars from the <code>String</code> * This method writes <code>len</code> chars from the <code>String</code>
* starting at position <code>offset</code>. * starting at position <code>offset</code>.
......
libjava/java/io/LineNumberInputStream.java
...@@ -57,7 +57,7 @@ package java.io; ...@@ -57,7 +57,7 @@ package java.io;
* stream, it has the same mark/reset functionality as the underlying * stream, it has the same mark/reset functionality as the underlying
* stream. The <code>mark()</code> and <code>reset()</code> methods * stream. The <code>mark()</code> and <code>reset()</code> methods
* in this class handle line numbers correctly. Calling * 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 * <code>mark()</code> was called if the subordinate stream supports
* that functionality. * that functionality.
* <p> * <p>
...@@ -119,7 +119,7 @@ public class LineNumberInputStream extends FilterInputStream ...@@ -119,7 +119,7 @@ public class LineNumberInputStream extends FilterInputStream
/** /**
* This method returns the current line number * This method returns the current line number
* *
* @returns The current line number * @return The current line number
*/ */
public int getLineNumber() public int getLineNumber()
{ {
......
libjava/java/io/ObjectInput.java
...@@ -58,8 +58,6 @@ public interface ObjectInput extends DataInput ...@@ -58,8 +58,6 @@ public interface ObjectInput extends DataInput
*/ */
public abstract int available() throws IOException; public abstract int available() throws IOException;
/*************************************************************************/
/** /**
* This method reading a byte of data from a stream. It returns that byte * 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. * as an int. This method blocks if no data is available to be read.
...@@ -70,8 +68,6 @@ public interface ObjectInput extends DataInput ...@@ -70,8 +68,6 @@ public interface ObjectInput extends DataInput
*/ */
public abstract int read() throws IOException; public abstract int read() throws IOException;
/*************************************************************************/
/** /**
* This method reads raw bytes and stores them them a byte array buffer. * 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, * Note that this method will block if no data is available. However,
...@@ -86,8 +82,6 @@ public interface ObjectInput extends DataInput ...@@ -86,8 +82,6 @@ public interface ObjectInput extends DataInput
*/ */
public abstract int read(byte[] buf) throws IOException; public abstract int read(byte[] buf) throws IOException;
/*************************************************************************/
/** /**
* This method reads raw bytes and stores them in a byte array buffer * This method reads raw bytes and stores them in a byte array buffer
* <code>buf</code> starting at position <code>offset</code> into the * <code>buf</code> starting at position <code>offset</code> into the
...@@ -107,8 +101,6 @@ public interface ObjectInput extends DataInput ...@@ -107,8 +101,6 @@ public interface ObjectInput extends DataInput
*/ */
public abstract int read(byte[] buf, int offset, int len) throws IOException; 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 * Reads an object instance and returns it. If the class for the object
* being read cannot be found, then a ClassNotFoundException will * being read cannot be found, then a ClassNotFoundException will
...@@ -123,8 +115,6 @@ public interface ObjectInput extends DataInput ...@@ -123,8 +115,6 @@ public interface ObjectInput extends DataInput
public abstract Object readObject() public abstract Object readObject()
throws ClassNotFoundException, IOException; throws ClassNotFoundException, IOException;
/*************************************************************************/
/** /**
* This method causes the specified number of bytes to be read and * This method causes the specified number of bytes to be read and
* discarded. It is possible that fewer than the requested number of bytes * discarded. It is possible that fewer than the requested number of bytes
...@@ -138,8 +128,6 @@ public interface ObjectInput extends DataInput ...@@ -138,8 +128,6 @@ public interface ObjectInput extends DataInput
*/ */
public abstract long skip(long num_bytes) throws IOException; public abstract long skip(long num_bytes) throws IOException;
/*************************************************************************/
/** /**
* This method closes the input source * This method closes the input source
* *
......
libjava/java/io/ObjectOutput.java
...@@ -58,8 +58,6 @@ public interface ObjectOutput extends DataOutput ...@@ -58,8 +58,6 @@ public interface ObjectOutput extends DataOutput
*/ */
public abstract void write(int b) throws IOException; public abstract void write(int b) throws IOException;
/*************************************************************************/
/** /**
* This method writes all the bytes in the specified byte array to the * This method writes all the bytes in the specified byte array to the
* output stream. * output stream.
...@@ -70,8 +68,6 @@ public interface ObjectOutput extends DataOutput ...@@ -70,8 +68,6 @@ public interface ObjectOutput extends DataOutput
*/ */
public abstract void write(byte[] buf) throws IOException; public abstract void write(byte[] buf) throws IOException;
/*************************************************************************/
/** /**
* This method writes <code>len</code> bytes from the specified array * This method writes <code>len</code> bytes from the specified array
* starting at index <code>offset</code> into that array. * starting at index <code>offset</code> into that array.
...@@ -85,8 +81,6 @@ public interface ObjectOutput extends DataOutput ...@@ -85,8 +81,6 @@ public interface ObjectOutput extends DataOutput
public abstract void write(byte[] buf, int offset, int len) public abstract void write(byte[] buf, int offset, int len)
throws IOException; throws IOException;
/*************************************************************************/
/** /**
* This method writes a object instance to a stream. The format of the * This method writes a object instance to a stream. The format of the
* data written is determined by the actual implementation of this method * data written is determined by the actual implementation of this method
...@@ -97,8 +91,6 @@ public interface ObjectOutput extends DataOutput ...@@ -97,8 +91,6 @@ public interface ObjectOutput extends DataOutput
*/ */
public abstract void writeObject(Object obj) throws IOException; public abstract void writeObject(Object obj) throws IOException;
/*************************************************************************/
/** /**
* This method causes any buffered data to be flushed out to the underlying * This method causes any buffered data to be flushed out to the underlying
* stream * stream
...@@ -107,8 +99,6 @@ public interface ObjectOutput extends DataOutput ...@@ -107,8 +99,6 @@ public interface ObjectOutput extends DataOutput
*/ */
public abstract void flush() throws IOException; public abstract void flush() throws IOException;
/*************************************************************************/
/** /**
* This method closes the underlying stream. * This method closes the underlying stream.
* *
......
libjava/java/io/ObjectStreamClass.java
...@@ -166,14 +166,14 @@ public class ObjectStreamClass implements Serializable ...@@ -166,14 +166,14 @@ public class ObjectStreamClass implements Serializable
/** /**
Returns a textual representation of this * Returns a textual representation of this
<code>ObjectStreamClass</code> object including the name of the * <code>ObjectStreamClass</code> object including the name of the
class it represents as well as that class's serial version * class it represents as well as that class's serial version
stream-unique identifier. * stream-unique identifier.
*
@see getSerialVersionUID () * @see #getSerialVersionUID()
@see getName () * @see #getName()
*/ */
public String toString () public String toString ()
{ {
return "java.io.ObjectStreamClass< " + name + ", " + uid + " >"; return "java.io.ObjectStreamClass< " + name + ", " + uid + " >";
......
libjava/java/io/PrintStream.java
/* PrintStream.java -- OutputStream for printing output /* 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. This file is part of GNU Classpath.
......
libjava/java/io/PushbackReader.java
...@@ -77,7 +77,7 @@ public class PushbackReader extends FilterReader ...@@ -77,7 +77,7 @@ public class PushbackReader extends FilterReader
* specified subordinate <code>Reader</code> with a default pushback buffer * specified subordinate <code>Reader</code> with a default pushback buffer
* size of 1. * size of 1.
* *
* @code in The subordinate stream to read from * @param in The subordinate stream to read from
*/ */
public PushbackReader(Reader in) public PushbackReader(Reader in)
{ {
......
libjava/java/io/SerializablePermission.java
...@@ -67,8 +67,6 @@ public final class SerializablePermission extends BasicPermission ...@@ -67,8 +67,6 @@ public final class SerializablePermission extends BasicPermission
private static final String[] legal_names = { "enableSubclassImplementation", private static final String[] legal_names = { "enableSubclassImplementation",
"enableSubstitution" }; "enableSubstitution" };
/*************************************************************************/
/* /*
* Constructors * Constructors
*/ */
...@@ -88,8 +86,6 @@ public final class SerializablePermission extends BasicPermission ...@@ -88,8 +86,6 @@ public final class SerializablePermission extends BasicPermission
this(name, null); this(name, null);
} }
/*************************************************************************/
/** /**
* This method initializes a new instance of * This method initializes a new instance of
* <code>SerializablePermission</code> * <code>SerializablePermission</code>
......
libjava/java/io/StreamTokenizer.java
...@@ -580,7 +580,7 @@ public class StreamTokenizer ...@@ -580,7 +580,7 @@ public class StreamTokenizer
* quote, and comment) from all characters. It is equivalent to calling * quote, and comment) from all characters. It is equivalent to calling
* <code>ordinaryChars(0x00, 0xFF)</code>. * <code>ordinaryChars(0x00, 0xFF)</code>.
* *
* @see ordinaryChars * @see #ordinaryChars(int, int)
*/ */
public void resetSyntax() 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