From be06f47bc163661477f50bf46e103314f1c24498 Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Tue, 16 Nov 2004 11:30:14 +0000 Subject: BufferedReader.java, [...]: Fixed javadocs all over. 2004-11-16 Michael Koch * 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 --- libjava/java/io/RandomAccessFile.java | 98 +++++++++++++++++------------------ 1 file changed, 48 insertions(+), 50 deletions(-) (limited to 'libjava/java/io/RandomAccessFile.java') 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 *

* 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 * buf.length 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 len bytes from the file into the * specified array starting at position offset 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 len 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 int in the following manner: *

- * (int)(((byte1 & 0xFF) << 24) + ((byte2 & 0xFF) << 16) + - * ((byte3 & 0xFF) << 8) + (byte4 & 0xFF))) + * (int)(((byte1 & 0xFF) << 24) + ((byte2 & 0xFF) << 16) + + * ((byte3 & 0xFF) << 8) + (byte4 & 0xFF))) *

* The value returned is in the range of 0 to 65535. *

@@ -524,10 +524,10 @@ public class RandomAccessFile implements DataOutput, DataInput * transformed to an long in the following manner: *

* - * (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))) + * (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))) *

* The value returned is in the range of 0 to 65535. *

@@ -612,7 +612,7 @@ public class RandomAccessFile implements DataOutput, DataInput * and second byte read from the stream respectively, they will be * transformed to an int in the following manner: *

- * (int)(((byte1 & 0xFF) << 8) + (byte2 & 0xFF)) + * (int)(((byte1 & 0xFF) << 8) + (byte2 & 0xFF)) *

* The value returned is in the range of 0 to 65535. *

@@ -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 len bytes to the file from the specified * array starting at index offset 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 true, 1 is written to the stream. * For a value of false, 0 is written. * - * @param b The boolean value to write to the stream + * @param val The boolean 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 byte value to the underlying * output stream. * - * @param b The byte to write to the stream, passed + * @param val The byte to write to the stream, passed * as an int. * * @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 short to the stream, high byte * first. This method requires two bytes to encode the value. * - * @param s The short value to write to the stream, + * @param val The short value to write to the stream, * passed as an int. * * @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 char value to the stream, * high byte first. * - * @param v The char value to write, passed as + * @param val The char value to write, passed as * an int. * * @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 int to the stream, high bytes * first. This method requires four bytes to encode the value. * - * @param v The int value to write to the stream. + * @param val The int 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 long to the stream, high bytes * first. This method requires eight bytes to encode the value. * - * @param v The long value to write to the stream. + * @param val The long 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 int value to the stream exactly the same * as the writeInt() 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 long value to the stream exactly the same * as the writeLong() 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 String. * The high eight bits of each character are discarded. * - * @param s The String to write to the stream + * @param val The String 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 String to write to the stream. + * @param val The String 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 String to write to the output in UTF format + * @param val The String 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 - +} -- cgit v1.1