--- old/src/share/classes/java/io/DataInput.java 2012-01-23 00:18:49.000000000 -0800 +++ new/src/share/classes/java/io/DataInput.java 2012-01-23 00:18:49.000000000 -0800 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995, 2006, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1995, 2012, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -26,12 +26,12 @@ package java.io; /** - * The DataInput interface provides + * The {@code DataInput} interface provides * for reading bytes from a binary stream and * reconstructing from them data in any of * the Java primitive types. There is also * a - * facility for reconstructing a String + * facility for reconstructing a {@code String} * from data in * modified UTF-8 * format. @@ -39,12 +39,12 @@ * It is generally true of all the reading * routines in this interface that if end of * file is reached before the desired number - * of bytes has been read, an EOFException - * (which is a kind of IOException) + * of bytes has been read, an {@code EOFException} + * (which is a kind of {@code IOException}) * is thrown. If any byte cannot be read for - * any reason other than end of file, an IOException - * other than EOFException is - * thrown. In particular, an IOException + * any reason other than end of file, an {@code IOException} + * other than {@code EOFException} is + * thrown. In particular, an {@code IOException} * may be thrown if the input stream has been * closed. * @@ -58,8 +58,8 @@ * Note that in the following tables, the most significant bit appears in the * far left-hand column. *

- * All characters in the range '\u0001' to - * '\u007F' are represented by a single byte: + * All characters in the range {@code '\u005Cu0001'} to + * {@code '\u005Cu007F'} are represented by a single byte: * *

* * *

- * The null character '\u0000' and characters in the - * range '\u0080' to '\u07FF' are + * The null character {@code '\u005Cu0000'} and characters in the + * range {@code '\u005Cu0080'} to {@code '\u005Cu07FF'} are * represented by a pair of bytes: * *

@@ -123,8 +123,8 @@ *
* *
- * char values in the range '\u0800' to - * '\uFFFF' are represented by three bytes: + * {@code char} values in the range {@code '\u005Cu0800'} to + * {@code '\u005CuFFFF'} are represented by three bytes: * *
*
- *
  • The null byte '\u0000' is encoded in 2-byte format + *
  • The null byte {@code '\u005Cu0000'} is encoded in 2-byte format * rather than 1-byte, so that the encoded strings never have * embedded nulls. *
  • Only the 1-byte, 2-byte, and 3-byte formats are used. @@ -195,36 +195,36 @@ /** * Reads some bytes from an input * stream and stores them into the buffer - * array b. The number of bytes + * array {@code b}. The number of bytes * read is equal - * to the length of b. + * to the length of {@code b}. *

    * This method blocks until one of the * following conditions occurs:

    *

    *

    - * If b is null, - * a NullPointerException is thrown. - * If b.length is zero, then + * If {@code b} is {@code null}, + * a {@code NullPointerException} is thrown. + * If {@code b.length} is zero, then * no bytes are read. Otherwise, the first - * byte read is stored into element b[0], - * the next one into b[1], and + * byte read is stored into element {@code b[0]}, + * the next one into {@code b[1]}, and * so on. * If an exception is thrown from * this method, then it may be that some but - * not all bytes of b have been + * not all bytes of {@code b} have been * updated with data from the input stream. * * @param b the buffer into which the data is read. @@ -236,7 +236,7 @@ /** * - * Reads len + * Reads {@code len} * bytes from * an input stream. *

    @@ -244,32 +244,32 @@ * blocks until one of the following conditions * occurs:

    *

    *

    - * If b is null, - * a NullPointerException is thrown. - * If off is negative, or len - * is negative, or off+len is - * greater than the length of the array b, - * then an IndexOutOfBoundsException + * If {@code b} is {@code null}, + * a {@code NullPointerException} is thrown. + * If {@code off} is negative, or {@code len} + * is negative, or {@code off+len} is + * greater than the length of the array {@code b}, + * then an {@code IndexOutOfBoundsException} * is thrown. - * If len is zero, + * If {@code len} is zero, * then no bytes are read. Otherwise, the first - * byte read is stored into element b[off], - * the next one into b[off+1], + * byte read is stored into element {@code b[off]}, + * the next one into {@code b[off+1]}, * and so on. The number of bytes read is, - * at most, equal to len. + * at most, equal to {@code len}. * * @param b the buffer into which the data is read. * @param off an int specifying the offset into the data. @@ -282,7 +282,7 @@ /** * Makes an attempt to skip over - * n bytes + * {@code n} bytes * of data from the input * stream, discarding the skipped bytes. However, * it may skip @@ -290,10 +290,10 @@ * bytes, possibly zero. This may result from * any of a * number of conditions; reaching - * end of file before n bytes + * end of file before {@code n} bytes * have been skipped is * only one possibility. - * This method never throws an EOFException. + * This method never throws an {@code EOFException}. * The actual * number of bytes skipped is returned. * @@ -305,13 +305,13 @@ /** * Reads one input byte and returns - * true if that byte is nonzero, - * false if that byte is zero. + * {@code true} if that byte is nonzero, + * {@code false} if that byte is zero. * This method is suitable for reading - * the byte written by the writeBoolean - * method of interface DataOutput. + * the byte written by the {@code writeBoolean} + * method of interface {@code DataOutput}. * - * @return the boolean value read. + * @return the {@code boolean} value read. * @exception EOFException if this stream reaches the end before reading * all the bytes. * @exception IOException if an I/O error occurs. @@ -321,11 +321,11 @@ /** * Reads and returns one input byte. * The byte is treated as a signed value in - * the range -128 through 127, + * the range {@code -128} through {@code 127}, * inclusive. * This method is suitable for - * reading the byte written by the writeByte - * method of interface DataOutput. + * reading the byte written by the {@code writeByte} + * method of interface {@code DataOutput}. * * @return the 8-bit value read. * @exception EOFException if this stream reaches the end before reading @@ -336,16 +336,16 @@ /** * Reads one input byte, zero-extends - * it to type int, and returns + * it to type {@code int}, and returns * the result, which is therefore in the range - * 0 - * through 255. + * {@code 0} + * through {@code 255}. * This method is suitable for reading - * the byte written by the writeByte - * method of interface DataOutput - * if the argument to writeByte + * the byte written by the {@code writeByte} + * method of interface {@code DataOutput} + * if the argument to {@code writeByte} * was intended to be a value in the range - * 0 through 255. + * {@code 0} through {@code 255}. * * @return the unsigned 8-bit value read. * @exception EOFException if this stream reaches the end before reading @@ -356,8 +356,8 @@ /** * Reads two input bytes and returns - * a short value. Let a - * be the first byte read and b + * a {@code short} value. Let {@code a} + * be the first byte read and {@code b} * be the second byte. The value * returned * is: @@ -365,8 +365,8 @@ * * This method * is suitable for reading the bytes written - * by the writeShort method of - * interface DataOutput. + * by the {@code writeShort} method of + * interface {@code DataOutput}. * * @return the 16-bit value read. * @exception EOFException if this stream reaches the end before reading @@ -377,19 +377,19 @@ /** * Reads two input bytes and returns - * an int value in the range 0 - * through 65535. Let a + * an {@code int} value in the range {@code 0} + * through {@code 65535}. Let {@code a} * be the first byte read and - * b + * {@code b} * be the second byte. The value returned is: * 

    (((a & 0xff) << 8) | (b & 0xff))
      *
    * This method is suitable for reading the bytes - * written by the writeShort method - * of interface DataOutput if - * the argument to writeShort + * written by the {@code writeShort} method + * of interface {@code DataOutput} if + * the argument to {@code writeShort} * was intended to be a value in the range - * 0 through 65535. + * {@code 0} through {@code 65535}. * * @return the unsigned 16-bit value read. * @exception EOFException if this stream reaches the end before reading @@ -399,19 +399,19 @@ int readUnsignedShort() throws IOException; /** - * Reads two input bytes and returns a char value. - * Let a - * be the first byte read and b + * Reads two input bytes and returns a {@code char} value. + * Let {@code a} + * be the first byte read and {@code b} * be the second byte. The value * returned is: * 

    (char)((a << 8) | (b & 0xff))
      *
    * This method * is suitable for reading bytes written by - * the writeChar method of interface - * DataOutput. + * the {@code writeChar} method of interface + * {@code DataOutput}. * - * @return the char value read. + * @return the {@code char} value read. * @exception EOFException if this stream reaches the end before reading * all the bytes. * @exception IOException if an I/O error occurs. @@ -420,18 +420,17 @@ /** * Reads four input bytes and returns an - * int value. Let a-d + * {@code int} value. Let {@code a-d} * be the first through fourth bytes read. The value returned is: - * 

    -     * 
+     * 
    
      * (((a & 0xff) << 24) | ((b & 0xff) << 16) |
      *  ((c & 0xff) << 8) | (d & 0xff))
      * 
    
      * This method is suitable
-     * for reading bytes written by the writeInt
-     * method of interface DataOutput.
+     * for reading bytes written by the {@code writeInt}
+     * method of interface {@code DataOutput}.
      *
-     * @return     the int value read.
+     * @return     the {@code int} value read.
      * @exception  EOFException  if this stream reaches the end before reading
      *               all the bytes.
      * @exception  IOException   if an I/O error occurs.
@@ -440,10 +439,10 @@
 
     /**
      * Reads eight input bytes and returns
-     * a long value. Let a-h
+     * a {@code long} value. Let {@code a-h}
      * be the first through eighth bytes read.
      * The value returned is:
-     * 
     
+     * 
    
      * (((long)(a & 0xff) << 56) |
      *  ((long)(b & 0xff) << 48) |
      *  ((long)(c & 0xff) << 40) |
@@ -455,10 +454,10 @@
      * 
    
      * 
    
      * This method is suitable
-     * for reading bytes written by the writeLong
-     * method of interface DataOutput.
+     * for reading bytes written by the {@code writeLong}
+     * method of interface {@code DataOutput}.
      *
-     * @return     the long value read.
+     * @return     the {@code long} value read.
      * @exception  EOFException  if this stream reaches the end before reading
      *               all the bytes.
      * @exception  IOException   if an I/O error occurs.
@@ -467,18 +466,18 @@
 
     /**
      * Reads four input bytes and returns
-     * a float value. It does this
-     * by first constructing an int
+     * a {@code float} value. It does this
+     * by first constructing an {@code int}
      * value in exactly the manner
-     * of the readInt
-     * method, then converting this int
-     * value to a float in
-     * exactly the manner of the method Float.intBitsToFloat.
+     * of the {@code readInt}
+     * method, then converting this {@code int}
+     * value to a {@code float} in
+     * exactly the manner of the method {@code Float.intBitsToFloat}.
      * This method is suitable for reading
-     * bytes written by the writeFloat
-     * method of interface DataOutput.
+     * bytes written by the {@code writeFloat}
+     * method of interface {@code DataOutput}.
      *
-     * @return     the float value read.
+     * @return     the {@code float} value read.
      * @exception  EOFException  if this stream reaches the end before reading
      *               all the bytes.
      * @exception  IOException   if an I/O error occurs.
@@ -487,18 +486,18 @@
 
     /**
      * Reads eight input bytes and returns
-     * a double value. It does this
-     * by first constructing a long
+     * a {@code double} value. It does this
+     * by first constructing a {@code long}
      * value in exactly the manner
-     * of the readlong
-     * method, then converting this long
-     * value to a double in exactly
-     * the manner of the method Double.longBitsToDouble.
+     * of the {@code readlong}
+     * method, then converting this {@code long}
+     * value to a {@code double} in exactly
+     * the manner of the method {@code Double.longBitsToDouble}.
      * This method is suitable for reading
-     * bytes written by the writeDouble
-     * method of interface DataOutput.
+     * bytes written by the {@code writeDouble}
+     * method of interface {@code DataOutput}.
      *
-     * @return     the double value read.
+     * @return     the {@code double} value read.
      * @exception  EOFException  if this stream reaches the end before reading
      *               all the bytes.
      * @exception  IOException   if an I/O error occurs.
@@ -512,35 +511,35 @@
      * until it encounters a line terminator or
      * end of
      * file; the characters read are then
-     * returned as a String. Note
+     * returned as a {@code String}. Note
      * that because this
      * method processes bytes,
      * it does not support input of the full Unicode
      * character set.
      * 
    
      * If end of file is encountered
-     * before even one byte can be read, then null
+     * before even one byte can be read, then {@code null}
      * is returned. Otherwise, each byte that is
-     * read is converted to type char
-     * by zero-extension. If the character '\n'
+     * read is converted to type {@code char}
+     * by zero-extension. If the character {@code '\n'}
      * is encountered, it is discarded and reading
-     * ceases. If the character '\r'
+     * ceases. If the character {@code '\r'}
      * is encountered, it is discarded and, if
      * the following byte converts  to the
-     * character '\n', then that is
+     * character {@code '\n'}, then that is
      * discarded also; reading then ceases. If
      * end of file is encountered before either
-     * of the characters '\n' and
-     * '\r' is encountered, reading
-     * ceases. Once reading has ceased, a String
+     * of the characters {@code '\n'} and
+     * {@code '\r'} is encountered, reading
+     * ceases. Once reading has ceased, a {@code String}
      * is returned that contains all the characters
      * read and not discarded, taken in order.
      * Note that every character in this string
-     * will have a value less than \u0100,
-     * that is, (char)256.
+     * will have a value less than {@code \u005Cu0100},
+     * that is, {@code (char)256}.
      *
      * @return the next line of text from the input stream,
-     *         or null if the end of file is
+     *         or {@code null} if the end of file is
      *         encountered before a byte can be read.
      * @exception  IOException  if an I/O error occurs.
      */
@@ -550,15 +549,15 @@
      * Reads in a string that has been encoded using a
      * modified UTF-8
      * format.
-     * The general contract of readUTF
+     * The general contract of {@code readUTF}
      * is that it reads a representation of a Unicode
      * character string encoded in modified
      * UTF-8 format; this string of characters
-     * is then returned as a String.
+     * is then returned as a {@code String}.
      * 
    
      * First, two bytes are read and used to
      * construct an unsigned 16-bit integer in
-     * exactly the manner of the readUnsignedShort
+     * exactly the manner of the {@code readUnsignedShort}
      * method . This integer value is called the
      * UTF length and specifies the number
      * of additional bytes to be read. These bytes
@@ -570,58 +569,58 @@
      * next group.
      * 
    
      * If the first byte of a group
-     * matches the bit pattern 0xxxxxxx
-     * (where x means "may be 0
-     * or 1"), then the group consists
+     * matches the bit pattern {@code 0xxxxxxx}
+     * (where {@code x} means "may be {@code 0}
+     * or {@code 1}"), then the group consists
      * of just that byte. The byte is zero-extended
      * to form a character.
      * 
    
      * If the first byte
-     * of a group matches the bit pattern 110xxxxx,
-     * then the group consists of that byte a
-     * and a second byte b. If there
-     * is no byte b (because byte
-     * a was the last of the bytes
-     * to be read), or if byte b does
-     * not match the bit pattern 10xxxxxx,
-     * then a UTFDataFormatException
+     * of a group matches the bit pattern {@code 110xxxxx},
+     * then the group consists of that byte {@code a}
+     * and a second byte {@code b}. If there
+     * is no byte {@code b} (because byte
+     * {@code a} was the last of the bytes
+     * to be read), or if byte {@code b} does
+     * not match the bit pattern {@code 10xxxxxx},
+     * then a {@code UTFDataFormatException}
      * is thrown. Otherwise, the group is converted
      * to the character:
    
      * 
    (char)(((a& 0x1F) << 6) | (b & 0x3F))
      * 
    
      * If the first byte of a group
-     * matches the bit pattern 1110xxxx,
-     * then the group consists of that byte a
-     * and two more bytes b and c.
-     * If there is no byte c (because
-     * byte a was one of the last
+     * matches the bit pattern {@code 1110xxxx},
+     * then the group consists of that byte {@code a}
+     * and two more bytes {@code b} and {@code c}.
+     * If there is no byte {@code c} (because
+     * byte {@code a} was one of the last
      * two of the bytes to be read), or either
-     * byte b or byte c
-     * does not match the bit pattern 10xxxxxx,
-     * then a UTFDataFormatException
+     * byte {@code b} or byte {@code c}
+     * does not match the bit pattern {@code 10xxxxxx},
+     * then a {@code UTFDataFormatException}
      * is thrown. Otherwise, the group is converted
      * to the character:
    
      * 
    
      * (char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))
      * 
    
      * If the first byte of a group matches the
-     * pattern 1111xxxx or the pattern
-     * 10xxxxxx, then a UTFDataFormatException
+     * pattern {@code 1111xxxx} or the pattern
+     * {@code 10xxxxxx}, then a {@code UTFDataFormatException}
      * is thrown.
      * 
    
      * If end of file is encountered
      * at any time during this entire process,
-     * then an EOFException is thrown.
+     * then an {@code EOFException} is thrown.
      * 
    
      * After every group has been converted to
      * a character by this process, the characters
      * are gathered, in the same order in which
      * their corresponding groups were read from
-     * the input stream, to form a String,
+     * the input stream, to form a {@code String},
      * which is returned.
      * 
    
-     * The writeUTF
-     * method of interface DataOutput
+     * The {@code writeUTF}
+     * method of interface {@code DataOutput}
      * may be used to write data that is suitable
      * for reading by this method.
      * @return     a Unicode string.