aboutsummaryrefslogtreecommitdiff
path: root/libjava/java/io
diff options
context:
space:
mode:
authorMichael Koch <konqueror@gmx.de>2004-11-16 11:30:14 +0000
committerMichael Koch <mkoch@gcc.gnu.org>2004-11-16 11:30:14 +0000
commitbe06f47bc163661477f50bf46e103314f1c24498 (patch)
tree35bc1efd9744250f460b2be74623c87b86db3c0d /libjava/java/io
parentd39289db5ad1bd3146c0f3aca3d1ebcbd83a3a14 (diff)
downloadgcc-be06f47bc163661477f50bf46e103314f1c24498.zip
gcc-be06f47bc163661477f50bf46e103314f1c24498.tar.gz
gcc-be06f47bc163661477f50bf46e103314f1c24498.tar.bz2
BufferedReader.java, [...]: Fixed javadocs all over.
2004-11-16 Michael Koch <konqueror@gmx.de> * java/io/BufferedReader.java, java/io/FileInputStream.java, java/io/FileOutputStream.java, java/io/FileWriter.java, java/io/OutputStreamWriter.java, java/io/PipedInputStream.java, java/io/PipedOutputStream.java, java/io/PipedReader.java, java/io/PipedWriter.java, java/io/PrintStream.java, java/io/PushbackInputStream.java, java/io/RandomAccessFile.java, java/io/Reader.java, java/io/StreamTokenizer.java, java/io/StringReader.java, java/net/NetworkInterface.java, java/net/URLClassLoader.java, java/nio/ByteOrder.java, java/nio/channels/Channel.java: Fixed javadocs all over. From-SVN: r90727
Diffstat (limited to 'libjava/java/io')
-rw-r--r--libjava/java/io/BufferedReader.java2
-rw-r--r--libjava/java/io/FileInputStream.java2
-rw-r--r--libjava/java/io/FileOutputStream.java6
-rw-r--r--libjava/java/io/FileWriter.java117
-rw-r--r--libjava/java/io/OutputStreamWriter.java2
-rw-r--r--libjava/java/io/PipedInputStream.java18
-rw-r--r--libjava/java/io/PipedOutputStream.java6
-rw-r--r--libjava/java/io/PipedReader.java14
-rw-r--r--libjava/java/io/PipedWriter.java6
-rw-r--r--libjava/java/io/PrintStream.java10
-rw-r--r--libjava/java/io/PushbackInputStream.java2
-rw-r--r--libjava/java/io/RandomAccessFile.java98
-rw-r--r--libjava/java/io/Reader.java6
-rw-r--r--libjava/java/io/StreamTokenizer.java28
-rw-r--r--libjava/java/io/StringReader.java6
15 files changed, 149 insertions, 174 deletions
diff --git a/libjava/java/io/BufferedReader.java b/libjava/java/io/BufferedReader.java
index 444b66d..1907470 100644
--- a/libjava/java/io/BufferedReader.java
+++ b/libjava/java/io/BufferedReader.java
@@ -508,7 +508,7 @@ public class BufferedReader extends Reader
* <code>skip</code> method on the underlying stream to skip the
* remaining chars.
*
- * @param numChars The requested number of chars to skip
+ * @param count The requested number of chars to skip
*
* @return The actual number of chars skipped.
*
diff --git a/libjava/java/io/FileInputStream.java b/libjava/java/io/FileInputStream.java
index 41d2403..908c00a 100644
--- a/libjava/java/io/FileInputStream.java
+++ b/libjava/java/io/FileInputStream.java
@@ -122,7 +122,7 @@ public class FileInputStream extends InputStream
* An exception is
* thrown if reading is not allowed.
*
- * @param fd The <code>FileDescriptor</code> object this stream
+ * @param fdObj The <code>FileDescriptor</code> object this stream
* should read from
*
* @exception SecurityException If read access to the file is not allowed
diff --git a/libjava/java/io/FileOutputStream.java b/libjava/java/io/FileOutputStream.java
index d81d6d1..1702ffe 100644
--- a/libjava/java/io/FileOutputStream.java
+++ b/libjava/java/io/FileOutputStream.java
@@ -72,7 +72,7 @@ public class FileOutputStream extends OutputStream
* one exists) with the name of the file to be opened. An exception is
* thrown if writing is not allowed.
*
- * @param name The name of the file this stream should write to
+ * @param path The name of the file this stream should write to
* @param append <code>true</code> to append bytes to the end of the file,
* or <code>false</code> to write bytes to the beginning
*
@@ -95,7 +95,7 @@ public class FileOutputStream extends OutputStream
* one exists) with the name of the file to be opened. An exception is
* thrown if writing is not allowed.
*
- * @param name The name of the file this stream should write to
+ * @param path The name of the file this stream should write to
*
* @exception SecurityException If write access to the file is not allowed
* @exception FileNotFoundException If a non-security error occurs
@@ -176,7 +176,7 @@ public class FileOutputStream extends OutputStream
* one exists) with the specified <code>FileDescriptor</code> as an argument.
* An exception is thrown if writing is not allowed.
*
- * @param file The <code>FileDescriptor</code> this stream should write to
+ * @param fdObj The <code>FileDescriptor</code> this stream should write to
*
* @exception SecurityException If write access to the file is not allowed
*/
diff --git a/libjava/java/io/FileWriter.java b/libjava/java/io/FileWriter.java
index 44db08c..fb48bba 100644
--- a/libjava/java/io/FileWriter.java
+++ b/libjava/java/io/FileWriter.java
@@ -1,5 +1,5 @@
/* FileWriter.java -- Convenience class for writing to files.
- Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc.
+ Copyright (C) 1998, 1999, 2001, 2003, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -49,96 +49,89 @@ package java.io;
* <code>OutputStreamWriter</code> to write to it.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
- * @author Tom Tromey <tromey@cygnus.com>
+ * @author Tom Tromey (tromey@cygnus.com)
*/
public class FileWriter extends OutputStreamWriter
{
-
- /*
- * Constructors
- */
-
/**
- * This method initializes a new <code>FileWriter</code> object to write
- * to the specified <code>File</code> object.
- *
- * @param file The <code>File</code> object to write to.
- *
- * @param SecurityException If writing to this file is forbidden by the
- * <code>SecurityManager</code>.
- * @param IOException If any other error occurs
- */
+ * This method initializes a new <code>FileWriter</code> object to write
+ * to the specified <code>File</code> object.
+ *
+ * @param file The <code>File</code> object to write to.
+ *
+ * @throws SecurityException If writing to this file is forbidden by the
+ * <code>SecurityManager</code>.
+ * @throws IOException If any other error occurs
+ */
public FileWriter(File file) throws SecurityException, IOException
{
super(new FileOutputStream(file));
}
/**
- * This method initializes a new <code>FileWriter</code> object to write
- * to the specified <code>File</code> object.
- *
- * @param file The <code>File</code> object to write to.
- * @param append <code>true</code> to start adding data at the end of the
- * file, <code>false</code> otherwise.
- *
- * @param SecurityException If writing to this file is forbidden by the
- * <code>SecurityManager</code>.
- * @param IOException If any other error occurs
- */
+ * This method initializes a new <code>FileWriter</code> object to write
+ * to the specified <code>File</code> object.
+ *
+ * @param file The <code>File</code> object to write to.
+ * @param append <code>true</code> to start adding data at the end of the
+ * file, <code>false</code> otherwise.
+ *
+ * @throws SecurityException If writing to this file is forbidden by the
+ * <code>SecurityManager</code>.
+ * @throws IOException If any other error occurs
+ */
public FileWriter(File file, boolean append) throws IOException
{
super(new FileOutputStream(file, append));
}
/**
- * This method initializes a new <code>FileWriter</code> object to write
- * to the specified <code>FileDescriptor</code> object.
- *
- * @param fd The <code>FileDescriptor</code> object to write to
- *
- * @param SecurityException If writing to this file is forbidden by the
- * <code>SecurityManager</code>.
- */
+ * This method initializes a new <code>FileWriter</code> object to write
+ * to the specified <code>FileDescriptor</code> object.
+ *
+ * @param fd The <code>FileDescriptor</code> object to write to
+ *
+ * @throws SecurityException If writing to this file is forbidden by the
+ * <code>SecurityManager</code>.
+ */
public FileWriter(FileDescriptor fd) throws SecurityException
{
super(new FileOutputStream(fd));
}
/**
- * This method intializes a new <code>FileWriter</code> object to
- * write to the
- * specified named file.
- *
- * @param name The name of the file to write to
- *
- * @param SecurityException If writing to this file is forbidden by the
- * <code>SecurityManager</code>.
- * @param IOException If any other error occurs
- */
+ * This method intializes a new <code>FileWriter</code> object to
+ * write to the
+ * specified named file.
+ *
+ * @param name The name of the file to write to
+ *
+ * @throws SecurityException If writing to this file is forbidden by the
+ * <code>SecurityManager</code>.
+ * @throws IOException If any other error occurs
+ */
public FileWriter(String name) throws IOException
{
super(new FileOutputStream(name));
}
/**
- * This method intializes a new <code>FileWriter</code> object to
- * write to the
- * specified named file. This form of the constructor allows the caller
- * to determin whether data should be written starting at the beginning or
- * the end of the file.
- *
- * @param name The name of the file to write to
- * @param append <code>true</code> to start adding data at the end of the
- * file, <code>false</code> otherwise.
- *
- * @param SecurityException If writing to this file is forbidden by the
- * <code>SecurityManager</code>.
- * @param IOException If any other error occurs
- */
+ * This method intializes a new <code>FileWriter</code> object to
+ * write to the
+ * specified named file. This form of the constructor allows the caller
+ * to determin whether data should be written starting at the beginning or
+ * the end of the file.
+ *
+ * @param name The name of the file to write to
+ * @param append <code>true</code> to start adding data at the end of the
+ * file, <code>false</code> otherwise.
+ *
+ * @throws SecurityException If writing to this file is forbidden by the
+ * <code>SecurityManager</code>.
+ * @throws IOException If any other error occurs
+ */
public FileWriter(String name, boolean append) throws IOException
{
super(new FileOutputStream(name, append));
}
-
-} // class FileWriter
-
+}
diff --git a/libjava/java/io/OutputStreamWriter.java b/libjava/java/io/OutputStreamWriter.java
index 8a47fdf..a07470a 100644
--- a/libjava/java/io/OutputStreamWriter.java
+++ b/libjava/java/io/OutputStreamWriter.java
@@ -287,7 +287,7 @@ public class OutputStreamWriter extends Writer
/**
* This method writes a single character to the output stream.
*
- * @param c The char to write, passed as an int.
+ * @param ch The char to write, passed as an int.
*
* @exception IOException If an error occurs
*/
diff --git a/libjava/java/io/PipedInputStream.java b/libjava/java/io/PipedInputStream.java
index 97700a0..906ef10 100644
--- a/libjava/java/io/PipedInputStream.java
+++ b/libjava/java/io/PipedInputStream.java
@@ -151,14 +151,14 @@ public class PipedInputStream extends InputStream
* This method receives a byte of input from the source PipedOutputStream.
* If the internal circular buffer is full, this method blocks.
*
- * @param byte_received The byte to write to this stream
+ * @param val The byte to write to this stream
*
* @exception IOException if error occurs
* @specnote Weird. This method must be some sort of accident.
*/
- protected synchronized void receive(int b) throws IOException
+ protected synchronized void receive(int val) throws IOException
{
- read_buf[0] = (byte) (b & 0xff);
+ read_buf[0] = (byte) (val & 0xff);
receive (read_buf, 0, 1);
}
@@ -237,11 +237,7 @@ public class PipedInputStream extends InputStream
* because the end of the stream was reached. If the stream is already
* closed, a -1 will again be returned to indicate the end of the stream.
* <p>
- * This method will block if no bytes are available to be read.
- *
- * @param buf The buffer into which bytes will be stored
- * @param offset The index into the buffer at which to start writing.
- * @param len The maximum number of bytes to read.
+ * This method will block if no byte is available to be read.
*/
public int read() throws IOException
{
@@ -252,11 +248,7 @@ public class PipedInputStream extends InputStream
// if this method is never called.
int r = read(read_buf, 0, 1);
-
- if (r == -1)
- return -1;
- else
- return read_buf[0];
+ return r != -1 ? read_buf[0] : -1;
}
/**
diff --git a/libjava/java/io/PipedOutputStream.java b/libjava/java/io/PipedOutputStream.java
index 09d8db7..a652356 100644
--- a/libjava/java/io/PipedOutputStream.java
+++ b/libjava/java/io/PipedOutputStream.java
@@ -129,21 +129,21 @@ public class PipedOutputStream extends OutputStream
* <code>PipedInputStream</code> to which this object is connected has
* a buffer that cannot hold all of the bytes to be written.
*
- * @param buf The array containing bytes to write to the stream.
+ * @param buffer The array containing bytes to write to the stream.
* @param offset The index into the array to start writing bytes from.
* @param len The number of bytes to write.
*
* @exception IOException If the stream has not been connected or has
* been closed.
*/
- public void write(byte[] b, int off, int len) throws IOException
+ public void write(byte[] buffer, int offset, int len) throws IOException
{
if (sink == null)
throw new IOException ("Not connected");
if (closed)
throw new IOException ("Pipe closed");
- sink.receive (b, off, len);
+ sink.receive(buffer, offset, len);
}
/**
diff --git a/libjava/java/io/PipedReader.java b/libjava/java/io/PipedReader.java
index 3991ba9..c91fc21 100644
--- a/libjava/java/io/PipedReader.java
+++ b/libjava/java/io/PipedReader.java
@@ -123,7 +123,7 @@ public class PipedReader extends Reader
* This stream is then ready for reading. If this stream is already
* connected or has been previously closed, then an exception is thrown
*
- * @param src The <code>PipedWriter</code> to connect this stream to
+ * @param source The <code>PipedWriter</code> to connect this stream to
*
* @exception IOException If this PipedReader or <code>source</code>
* has been connected already.
@@ -218,11 +218,7 @@ public class PipedReader extends Reader
* because the end of the stream was reached. If the stream is already
* closed, a -1 will again be returned to indicate the end of the stream.
* <p>
- * This method will block if no chars are available to be read.
- *
- * @param buf The buffer into which chars will be stored
- * @param offset The index into the buffer at which to start writing.
- * @param len The maximum number of chars to read.
+ * This method will block if no char is available to be read.
*/
public int read() throws IOException
{
@@ -233,11 +229,7 @@ public class PipedReader extends Reader
// if this method is never called.
int r = read(read_buf, 0, 1);
-
- if (r == -1)
- return -1;
- else
- return read_buf[0];
+ return r != -1 ? read_buf[0] : -1;
}
/**
diff --git a/libjava/java/io/PipedWriter.java b/libjava/java/io/PipedWriter.java
index e1a2115..e053d55 100644
--- a/libjava/java/io/PipedWriter.java
+++ b/libjava/java/io/PipedWriter.java
@@ -128,21 +128,21 @@ public class PipedWriter extends Writer
* <code>PipedReader</code> to which this object is connected has
* a buffer that cannot hold all of the chars to be written.
*
- * @param buf The array containing chars to write to the stream.
+ * @param buffer The array containing chars to write to the stream.
* @param offset The index into the array to start writing chars from.
* @param len The number of chars to write.
*
* @exception IOException If the stream has not been connected or has
* been closed.
*/
- public void write(char[] b, int off, int len) throws IOException
+ public void write(char[] buffer, int offset, int len) throws IOException
{
if (sink == null)
throw new IOException ("Not connected");
if (closed)
throw new IOException ("Pipe closed");
- sink.receive (b, off, len);
+ sink.receive(buffer, offset, len);
}
/**
diff --git a/libjava/java/io/PrintStream.java b/libjava/java/io/PrintStream.java
index 2e9bfc4..3526473 100644
--- a/libjava/java/io/PrintStream.java
+++ b/libjava/java/io/PrintStream.java
@@ -279,7 +279,7 @@ public class PrintStream extends FilterOutputStream
* values are printed as "true" and <code>false</code> values are printed
* as "false".
*
- * @param b The <code>boolean</code> value to print
+ * @param bool The <code>boolean</code> value to print
*/
public void print (boolean bool)
{
@@ -369,7 +369,7 @@ public class PrintStream extends FilterOutputStream
* This method prints an array of characters to the stream. The actual
* value printed depends on the system default encoding.
*
- * @param s The array of characters to print.
+ * @param charArray The array of characters to print.
*/
public void print (char[] charArray)
{
@@ -393,7 +393,7 @@ public class PrintStream extends FilterOutputStream
* <p>
* This method prints a line termination sequence after printing the value.
*
- * @param b The <code>boolean</code> value to print
+ * @param bool The <code>boolean</code> value to print
*/
public void println (boolean bool)
{
@@ -499,7 +499,7 @@ public class PrintStream extends FilterOutputStream
* <p>
* This method prints a line termination sequence after printing the value.
*
- * @param s The array of characters to print.
+ * @param charArray The array of characters to print.
*/
public void println (char[] charArray)
{
@@ -511,7 +511,7 @@ public class PrintStream extends FilterOutputStream
* enabled, printing a newline character will cause the stream to be
* flushed after the character is written.
*
- * @param b The byte to be written
+ * @param oneByte The byte to be written
*/
public void write (int oneByte)
{
diff --git a/libjava/java/io/PushbackInputStream.java b/libjava/java/io/PushbackInputStream.java
index 379677d..c07714e 100644
--- a/libjava/java/io/PushbackInputStream.java
+++ b/libjava/java/io/PushbackInputStream.java
@@ -302,7 +302,7 @@ public class PushbackInputStream extends FilterInputStream
* <code>skip</code> method on the underlying <code>InputStream</code> to
* skip additional bytes if necessary.
*
- * @param numBytes The requested number of bytes to skip
+ * @param n The requested number of bytes to skip
*
* @return The actual number of bytes skipped.
*
diff --git a/libjava/java/io/RandomAccessFile.java b/libjava/java/io/RandomAccessFile.java
index a99abd2..2b1e085 100644
--- a/libjava/java/io/RandomAccessFile.java
+++ b/libjava/java/io/RandomAccessFile.java
@@ -205,7 +205,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* <p>
* The file must be open for write access for this operation to succeed.
*
- * @param newlen The new length of the file
+ * @param newLen The new length of the file
*
* @exception IOException If an error occurs
*/
@@ -256,7 +256,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* bytes are stored starting at the beginning of the array and up to
* <code>buf.length</code> bytes can be read.
*
- * @param buf The buffer to read bytes from the file into
+ * @param buffer The buffer to read bytes from the file into
*
* @return The actual number of bytes read or -1 if end of file
*
@@ -271,7 +271,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* This methods reads up to <code>len</code> bytes from the file into the
* specified array starting at position <code>offset</code> into the array.
*
- * @param buf The array to read the bytes into
+ * @param buffer The array to read the bytes into
* @param offset The index into the array to start storing bytes
* @param len The requested number of bytes to read
*
@@ -414,7 +414,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* throws an exception if there is not enough data left in the stream to
* fill the buffer
*
- * @param buf The buffer into which to read the data
+ * @param buffer The buffer into which to read the data
*
* @exception EOFException If end of file is reached before filling the
* buffer
@@ -434,9 +434,9 @@ public class RandomAccessFile implements DataOutput, DataInput
* available and throws an exception if there is not enough data left in
* the stream to read <code>len</code> bytes.
*
- * @param buf The buffer into which to read the data
+ * @param buffer The buffer into which to read the data
* @param offset The offset into the buffer to start storing data
- * @param len The number of bytes to read into the buffer
+ * @param count The number of bytes to read into the buffer
*
* @exception EOFException If end of file is reached before filling
* the buffer
@@ -460,8 +460,8 @@ public class RandomAccessFile implements DataOutput, DataInput
* four bytes read from the stream, they will be
* transformed to an <code>int</code> in the following manner:
* <p>
- * <code>(int)(((byte1 & 0xFF) << 24) + ((byte2 & 0xFF) << 16) +
- * ((byte3 & 0xFF) << 8) + (byte4 & 0xFF)))</code>
+ * <code>(int)(((byte1 &amp; 0xFF) &lt;&lt; 24) + ((byte2 &amp; 0xFF) &lt;&lt; 16) +
+ * ((byte3 &amp; 0xFF) &lt;&lt; 8) + (byte4 &amp; 0xFF)))</code>
* <p>
* The value returned is in the range of 0 to 65535.
* <p>
@@ -524,10 +524,10 @@ public class RandomAccessFile implements DataOutput, DataInput
* transformed to an <code>long</code> in the following manner:
* <p>
* <code>
- * (long)((((long)byte1 & 0xFF) << 56) + (((long)byte2 & 0xFF) << 48) +
- * (((long)byte3 & 0xFF) << 40) + (((long)byte4 & 0xFF) << 32) +
- * (((long)byte5 & 0xFF) << 24) + (((long)byte6 & 0xFF) << 16) +
- * (((long)byte7 & 0xFF) << 8) + ((long)byte9 & 0xFF)))</code>
+ * (long)((((long)byte1 &amp; 0xFF) &lt;&lt; 56) + (((long)byte2 &amp; 0xFF) &lt;&lt; 48) +
+ * (((long)byte3 &amp; 0xFF) &lt;&lt; 40) + (((long)byte4 &amp; 0xFF) &lt;&lt; 32) +
+ * (((long)byte5 &amp; 0xFF) &lt;&lt; 24) + (((long)byte6 &amp; 0xFF) &lt;&lt; 16) +
+ * (((long)byte7 &amp; 0xFF) &lt;&lt; 8) + ((long)byte9 &amp; 0xFF)))</code>
* <p>
* The value returned is in the range of 0 to 65535.
* <p>
@@ -612,7 +612,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* and second byte read from the stream respectively, they will be
* transformed to an <code>int</code> in the following manner:
* <p>
- * <code>(int)(((byte1 & 0xFF) << 8) + (byte2 & 0xFF))</code>
+ * <code>(int)(((byte1 &amp; 0xFF) &lt;&lt; 8) + (byte2 &amp; 0xFF))</code>
* <p>
* The value returned is in the range of 0 to 65535.
* <p>
@@ -756,7 +756,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* This method writes a single byte of data to the file. The file must
* be open for read-write in order for this operation to succeed.
*
- * @param The byte of data to write, passed as an int.
+ * @param oneByte The byte of data to write, passed as an int.
*
* @exception IOException If an error occurs
*/
@@ -769,7 +769,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* This method writes all the bytes in the specified array to the file.
* The file must be open read-write in order for this operation to succeed.
*
- * @param buf The array of bytes to write to the file
+ * @param buffer The array of bytes to write to the file
*/
public void write (byte[] buffer) throws IOException
{
@@ -780,7 +780,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* This method writes <code>len</code> bytes to the file from the specified
* array starting at index <code>offset</code> into the array.
*
- * @param buf The array of bytes to write to the file
+ * @param buffer The array of bytes to write to the file
* @param offset The index into the array to start writing file
* @param len The number of bytes to write
*
@@ -796,7 +796,7 @@ public class RandomAccessFile implements DataOutput, DataInput
* stream. For a value of <code>true</code>, 1 is written to the stream.
* For a value of <code>false</code>, 0 is written.
*
- * @param b The <code>boolean</code> value to write to the stream
+ * @param val The <code>boolean</code> value to write to the stream
*
* @exception IOException If an error occurs
*/
@@ -809,68 +809,68 @@ public class RandomAccessFile implements DataOutput, DataInput
* This method writes a Java <code>byte</code> value to the underlying
* output stream.
*
- * @param b The <code>byte</code> to write to the stream, passed
+ * @param val The <code>byte</code> to write to the stream, passed
* as an <code>int</code>.
*
* @exception IOException If an error occurs
*/
- public final void writeByte (int v) throws IOException
+ public final void writeByte (int val) throws IOException
{
- out.writeByte(v);
+ out.writeByte(val);
}
/**
* This method writes a Java <code>short</code> to the stream, high byte
* first. This method requires two bytes to encode the value.
*
- * @param s The <code>short</code> value to write to the stream,
+ * @param val The <code>short</code> value to write to the stream,
* passed as an <code>int</code>.
*
* @exception IOException If an error occurs
*/
- public final void writeShort (int v) throws IOException
+ public final void writeShort (int val) throws IOException
{
- out.writeShort(v);
+ out.writeShort(val);
}
/**
* This method writes a single <code>char</code> value to the stream,
* high byte first.
*
- * @param v The <code>char</code> value to write, passed as
+ * @param val The <code>char</code> value to write, passed as
* an <code>int</code>.
*
* @exception IOException If an error occurs
*/
- public final void writeChar (int v) throws IOException
+ public final void writeChar (int val) throws IOException
{
- out.writeChar(v);
+ out.writeChar(val);
}
/**
* This method writes a Java <code>int</code> to the stream, high bytes
* first. This method requires four bytes to encode the value.
*
- * @param v The <code>int</code> value to write to the stream.
+ * @param val The <code>int</code> value to write to the stream.
*
* @exception IOException If an error occurs
*/
- public final void writeInt (int v) throws IOException
+ public final void writeInt (int val) throws IOException
{
- out.writeInt(v);
+ out.writeInt(val);
}
/**
* This method writes a Java <code>long</code> to the stream, high bytes
* first. This method requires eight bytes to encode the value.
*
- * @param v The <code>long</code> value to write to the stream.
+ * @param val The <code>long</code> value to write to the stream.
*
* @exception IOException If an error occurs
*/
- public final void writeLong (long v) throws IOException
+ public final void writeLong (long val) throws IOException
{
- out.writeLong(v);
+ out.writeLong(val);
}
/**
@@ -881,15 +881,15 @@ public class RandomAccessFile implements DataOutput, DataInput
* then writing this <code>int</code> value to the stream exactly the same
* as the <code>writeInt()</code> method does.
*
- * @param v The floating point number to write to the stream.
+ * @param val The floating point number to write to the stream.
*
* @exception IOException If an error occurs
*
* @see #writeInt(int)
*/
- public final void writeFloat (float v) throws IOException
+ public final void writeFloat (float val) throws IOException
{
- out.writeFloat(v);
+ out.writeFloat(val);
}
/**
@@ -900,16 +900,16 @@ public class RandomAccessFile implements DataOutput, DataInput
* then writing this <code>long</code> value to the stream exactly the same
* as the <code>writeLong()</code> method does.
*
- * @param v The double precision floating point number to write to the
+ * @param val The double precision floating point number to write to the
* stream.
*
* @exception IOException If an error occurs
*
* @see #writeLong(long)
*/
- public final void writeDouble (double v) throws IOException
+ public final void writeDouble (double val) throws IOException
{
- out.writeDouble(v);
+ out.writeDouble(val);
}
/**
@@ -917,13 +917,13 @@ public class RandomAccessFile implements DataOutput, DataInput
* stream. One byte is written for each character in the <code>String</code>.
* The high eight bits of each character are discarded.
*
- * @param s The <code>String</code> to write to the stream
+ * @param val The <code>String</code> to write to the stream
*
* @exception IOException If an error occurs
*/
- public final void writeBytes (String s) throws IOException
+ public final void writeBytes (String val) throws IOException
{
- out.writeBytes(s);
+ out.writeBytes(val);
}
/**
@@ -931,13 +931,13 @@ public class RandomAccessFile implements DataOutput, DataInput
* stream. There will be two bytes for each character value. The high
* byte of the character will be written first.
*
- * @param s The <code>String</code> to write to the stream.
+ * @param val The <code>String</code> to write to the stream.
*
* @exception IOException If an error occurs
*/
- public final void writeChars (String s) throws IOException
+ public final void writeChars (String val) throws IOException
{
- out.writeChars(s);
+ out.writeChars(val);
}
/**
@@ -965,13 +965,13 @@ public class RandomAccessFile implements DataOutput, DataInput
* character value are stored in bits 0-5 of byte three, with the high bits
* of that byte set to "10".
*
- * @param s The <code>String</code> to write to the output in UTF format
+ * @param val The <code>String</code> to write to the output in UTF format
*
* @exception IOException If an error occurs
*/
- public final void writeUTF (String s) throws IOException
+ public final void writeUTF (String val) throws IOException
{
- out.writeUTF(s);
+ out.writeUTF(val);
}
/**
@@ -984,6 +984,4 @@ public class RandomAccessFile implements DataOutput, DataInput
{
return ch;
}
-
-} // class RandomAccessFile
-
+}
diff --git a/libjava/java/io/Reader.java b/libjava/java/io/Reader.java
index be87949..18481ac 100644
--- a/libjava/java/io/Reader.java
+++ b/libjava/java/io/Reader.java
@@ -103,7 +103,7 @@ public abstract class Reader
*
* @param buf The array into which the chars read should be stored
* @param offset The offset into the array to start storing chars
- * @param len 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.
*
@@ -189,7 +189,7 @@ public abstract class Reader
* <code>reset()</code> method is called, then the mark is invalid and the
* stream object instance is not required to remember the mark.
*
- * @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
*
* @exception IOException If an error occurs such as mark not being
@@ -243,7 +243,7 @@ public abstract class Reader
* override this method to provide a more efficient implementation where
* one exists.
*
- * @param num_chars The requested number of chars to skip
+ * @param count The requested number of chars to skip
*
* @return The actual number of chars skipped.
*
diff --git a/libjava/java/io/StreamTokenizer.java b/libjava/java/io/StreamTokenizer.java
index 5c777b3..dd6acb3 100644
--- a/libjava/java/io/StreamTokenizer.java
+++ b/libjava/java/io/StreamTokenizer.java
@@ -122,7 +122,7 @@ public class StreamTokenizer
* them. For details on how this method operates by default, see
* <code>StreamTokenizer(Reader)</code>.
*
- * @param in The <code>InputStream</code> to read from
+ * @param is The <code>InputStream</code> to read from
*
* @deprecated Since JDK 1.1.
*/
@@ -150,7 +150,7 @@ public class StreamTokenizer
* <li>C and C++ (//) comments are not recognized</li>
* </ul>
*
- * @param in The <code>Reader</code> to read chars from
+ * @param r The <code>Reader</code> to read chars from
*/
public StreamTokenizer(Reader r)
{
@@ -170,7 +170,7 @@ public class StreamTokenizer
* This method sets the comment attribute on the specified
* character. Other attributes for the character are cleared.
*
- * @param c The character to set the comment attribute for, passed as an int
+ * @param ch The character to set the comment attribute for, passed as an int
*/
public void commentChar(int ch)
{
@@ -517,7 +517,7 @@ public class StreamTokenizer
* quote, or comment) will be set on this character. This character will
* parse as its own token.
*
- * @param c The character to make ordinary, passed as an int
+ * @param ch The character to make ordinary, passed as an int
*/
public void ordinaryChar(int ch)
{
@@ -533,9 +533,9 @@ public class StreamTokenizer
* range parse as its own token.
*
* @param low The low end of the range of values to set the whitespace
- * attribute for
- * @param high The high end of the range of values to set the whitespace
- * attribute for
+ * attribute for
+ * @param hi The high end of the range of values to set the whitespace
+ * attribute for
*/
public void ordinaryChars(int low, int hi)
{
@@ -575,7 +575,7 @@ public class StreamTokenizer
* This method sets the quote attribute on the specified character.
* Other attributes for the character are cleared.
*
- * @param c The character to set the quote attribute for, passed as an int.
+ * @param ch The character to set the quote attribute for, passed as an int.
*/
public void quoteChar(int ch)
{
@@ -670,9 +670,9 @@ public class StreamTokenizer
* specified range, range terminators included.
*
* @param low The low end of the range of values to set the whitespace
- * attribute for
- * @param high The high end of the range of values to set the whitespace
- * attribute for
+ * attribute for
+ * @param hi The high end of the range of values to set the whitespace
+ * attribute for
*/
public void whitespaceChars(int low, int hi)
{
@@ -692,9 +692,9 @@ public class StreamTokenizer
* specified range, range terminators included.
*
* @param low The low end of the range of values to set the alphabetic
- * attribute for
- * @param high The high end of the range of values to set the alphabetic
- * attribute for
+ * attribute for
+ * @param hi The high end of the range of values to set the alphabetic
+ * attribute for
*/
public void wordChars(int low, int hi)
{
diff --git a/libjava/java/io/StringReader.java b/libjava/java/io/StringReader.java
index 8153d80..372f5c0 100644
--- a/libjava/java/io/StringReader.java
+++ b/libjava/java/io/StringReader.java
@@ -52,7 +52,7 @@ package java.io;
* method rewinds the read pointer to the beginning of the <code>String</code>.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
- * @author Warren Levy <warrenl@cygnus.com>
+ * @author Warren Levy (warrenl@cygnus.com)
* @date October 19, 1998.
*/
public class StringReader extends Reader
@@ -74,7 +74,7 @@ public class StringReader extends Reader
* passed in <code>String</code>. This stream will read from the beginning
* to the end of the <code>String</code>.
*
- * @param s The <code>String</code> this stream will read from.
+ * @param buffer The <code>String</code> this stream will read from.
*/
public StringReader(String buffer)
{
@@ -185,7 +185,7 @@ public class StringReader extends Reader
* buffer, then only enough chars are skipped to position the stream at
* the end of the buffer. The actual number of chars skipped is returned.
*
- * @param num_chars The requested number of chars to skip
+ * @param n The requested number of chars to skip
*
* @return The actual number of chars skipped.
*/