jdk-sandbox: comparison src/java.base/share/classes/java/io/DataInputStream.java

equal deleted inserted replaced

-:13588c901957
+:9cf78a70fa4f
 /*
-* Copyright (c) 1994, 2016, Oracle and/or its affiliates. All rights reserved.
+* Copyright (c) 1994, 2019, 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
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 private byte bytearr[] = new byte[80];
 private char chararr[] = new char[80];
 /**
 * Reads some number of bytes from the contained input stream and
-* stores them into the buffer array <code>b</code>. The number of
+* stores them into the buffer array {@code b}. The number of
 * bytes actually read is returned as an integer. This method blocks
 * until input data is available, end of file is detected, or an
 * exception is thrown.
 *
-* <p>If <code>b</code> is null, a <code>NullPointerException</code> is
+* <p>If {@code b} is null, a {@code NullPointerException} is
-* thrown. If the length of <code>b</code> is zero, then no bytes are
+* thrown. If the length of {@code b} is zero, then no bytes are
-* read and <code>0</code> is returned; otherwise, there is an attempt
+* read and {@code 0} is returned; otherwise, there is an attempt
 * to read at least one byte. If no byte is available because the
-* stream is at end of file, the value <code>-1</code> is returned;
+* stream is at end of file, the value {@code -1} is returned;
-* otherwise, at least one byte is read and stored into <code>b</code>.
+* otherwise, at least one byte is read and stored into {@code b}.
 *
-* <p>The first byte read is stored into element <code>b[0]</code>, the
+* <p>The first byte read is stored into element {@code b[0]}, the
-* next one into <code>b[1]</code>, and so on. The number of bytes read
+* next one into {@code b[1]}, and so on. The number of bytes read
-* is, at most, equal to the length of <code>b</code>. Let <code>k</code>
+* is, at most, equal to the length of {@code b}. Let {@code k}
 * be the number of bytes actually read; these bytes will be stored in
-* elements <code>b[0]</code> through <code>b[k-1]</code>, leaving
+* elements {@code b[0]} through {@code b[k-1]}, leaving
-* elements <code>b[k]</code> through <code>b[b.length-1]</code>
+* elements {@code b[k]} through {@code b[b.length-1]}
 * unaffected.
 *
-* <p>The <code>read(b)</code> method has the same effect as:
+* <p>The {@code read(b)} method has the same effect as:
 * <blockquote><pre>
 * read(b, 0, b.length)
 * </pre></blockquote>
 *
 * @param      b   the buffer into which the data is read.
 * @return     the total number of bytes read into the buffer, or
-*             <code>-1</code> if there is no more data because the end
+*             {@code -1} if there is no more data because the end
 *             of the stream has been reached.
-* @exception  IOException if the first byte cannot be read for any reason
+* @throws     IOException if the first byte cannot be read for any reason
-* other than end of file, the stream has been closed and the underlying
+*             other than end of file, the stream has been closed and the underlying
-* input stream does not support reading after close, or another I/O
+*             input stream does not support reading after close, or another I/O
-* error occurs.
+*             error occurs.
 * @see        java.io.FilterInputStream#in
 * @see        java.io.InputStream#read(byte[], int, int)
 */
 public final int read(byte b[]) throws IOException {
 return in.read(b, 0, b.length);
 }
 /**
-* Reads up to <code>len</code> bytes of data from the contained
+* Reads up to {@code len} bytes of data from the contained
 * input stream into an array of bytes.  An attempt is made to read
-* as many as <code>len</code> bytes, but a smaller number may be read,
+* as many as {@code len} bytes, but a smaller number may be read,
 * possibly zero. The number of bytes actually read is returned as an
 * integer.
 *
 * <p> This method blocks until input data is available, end of file is
 * detected, or an exception is thrown.
 *
-* <p> If <code>len</code> is zero, then no bytes are read and
+* <p> If {@code len} is zero, then no bytes are read and
-* <code>0</code> is returned; otherwise, there is an attempt to read at
+* {@code 0} is returned; otherwise, there is an attempt to read at
 * least one byte. If no byte is available because the stream is at end of
-* file, the value <code>-1</code> is returned; otherwise, at least one
+* file, the value {@code -1} is returned; otherwise, at least one
-* byte is read and stored into <code>b</code>.
+* byte is read and stored into {@code b}.
 *
-* <p> The first byte read is stored into element <code>b[off]</code>, the
+* <p> The first byte read is stored into element {@code b[off]}, the
-* next one into <code>b[off+1]</code>, and so on. The number of bytes read
+* next one into {@code b[off+1]}, and so on. The number of bytes read
-* is, at most, equal to <code>len</code>. Let <i>k</i> be the number of
+* is, at most, equal to {@code len}. Let <i>k</i> be the number of
 * bytes actually read; these bytes will be stored in elements
-* <code>b[off]</code> through <code>b[off+</code><i>k</i><code>-1]</code>,
+* {@code b[off]} through {@code b[off+}<i>k</i>{@code -1]},
-* leaving elements <code>b[off+</code><i>k</i><code>]</code> through
+* leaving elements {@code b[off+}<i>k</i>{@code ]} through
-* <code>b[off+len-1]</code> unaffected.
+* {@code b[off+len-1]} unaffected.
 *
-* <p> In every case, elements <code>b[0]</code> through
+* <p> In every case, elements {@code b[0]} through
-* <code>b[off]</code> and elements <code>b[off+len]</code> through
+* {@code b[off]} and elements {@code b[off+len]} through
-* <code>b[b.length-1]</code> are unaffected.
+* {@code b[b.length-1]} are unaffected.
 *
 * @param      b     the buffer into which the data is read.
-* @param off the start offset in the destination array <code>b</code>
+* @param      off the start offset in the destination array {@code b}
 * @param      len   the maximum number of bytes read.
 * @return     the total number of bytes read into the buffer, or
-*             <code>-1</code> if there is no more data because the end
+*             {@code -1} if there is no more data because the end
 *             of the stream has been reached.
-* @exception  NullPointerException If <code>b</code> is <code>null</code>.
+* @throws     NullPointerException If {@code b} is {@code null}.
-* @exception  IndexOutOfBoundsException If <code>off</code> is negative,
+* @throws     IndexOutOfBoundsException If {@code off} is negative,
-* <code>len</code> is negative, or <code>len</code> is greater than
+*             {@code len} is negative, or {@code len} is greater than
-* <code>b.length - off</code>
+*             {@code b.length - off}
-* @exception  IOException if the first byte cannot be read for any reason
+* @throws     IOException if the first byte cannot be read for any reason
-* other than end of file, the stream has been closed and the underlying
+*             other than end of file, the stream has been closed and the underlying
-* input stream does not support reading after close, or another I/O
+*             input stream does not support reading after close, or another I/O
-* error occurs.
+*             error occurs.
 * @see        java.io.FilterInputStream#in
 * @see        java.io.InputStream#read(byte[], int, int)
 */
 public final int read(byte b[], int off, int len) throws IOException {
 return in.read(b, off, len);
 * input stream.
 *
 * @param      b     the buffer into which the data is read.
 * @param      off   the start offset in the data array {@code b}.
 * @param      len   the number of bytes to read.
-* @exception  NullPointerException if {@code b} is {@code null}.
+* @throws     NullPointerException if {@code b} is {@code null}.
-* @exception  IndexOutOfBoundsException if {@code off} is negative,
+* @throws     IndexOutOfBoundsException if {@code off} is negative,
 *             {@code len} is negative, or {@code len} is greater than
 *             {@code b.length - off}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *             reading all the bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final void readFully(byte b[], int off, int len) throws IOException {
 n += count;
 }
 }
 /**
-* See the general contract of the <code>skipBytes</code>
+* See the general contract of the {@code skipBytes}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes for this operation are read from the contained
 * input stream.
 *
 * @param      n   the number of bytes to be skipped.
 * @return     the actual number of bytes skipped.
-* @exception  IOException  if the contained input stream does not support
+* @throws     IOException  if the contained input stream does not support
 *             seek, or the stream has been closed and
 *             the contained input stream does not support
 *             reading after close, or another I/O error occurs.
 */
 public final int skipBytes(int n) throws IOException {
 return total;
 }
 /**
-* See the general contract of the <code>readBoolean</code>
+* See the general contract of the {@code readBoolean}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes for this operation are read from the contained
 * input stream.
 *
-* @return     the <code>boolean</code> value read.
+* @return     the {@code boolean} value read.
-* @exception  EOFException  if this input stream has reached the end.
+* @throws     EOFException  if this input stream has reached the end.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final boolean readBoolean() throws IOException {
 throw new EOFException();
 return (ch != 0);
 }
 /**
-* See the general contract of the <code>readByte</code>
+* See the general contract of the {@code readByte}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next byte of this input stream as a signed 8-bit
-*             <code>byte</code>.
+*             {@code byte}.
-* @exception  EOFException  if this input stream has reached the end.
+* @throws     EOFException  if this input stream has reached the end.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final byte readByte() throws IOException {
 throw new EOFException();
 return (byte)(ch);
 }
 /**
-* See the general contract of the <code>readUnsignedByte</code>
+* See the general contract of the {@code readUnsignedByte}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next byte of this input stream, interpreted as an
 *             unsigned 8-bit number.
-* @exception  EOFException  if this input stream has reached the end.
+* @throws     EOFException  if this input stream has reached the end.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see         java.io.FilterInputStream#in
 */
 public final int readUnsignedByte() throws IOException {
 throw new EOFException();
 return ch;
 }
 /**
-* See the general contract of the <code>readShort</code>
+* See the general contract of the {@code readShort}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next two bytes of this input stream, interpreted as a
 *             signed 16-bit number.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading two bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final short readShort() throws IOException {
 throw new EOFException();
 return (short)((ch1 << 8) + (ch2 << 0));
 }
 /**
-* See the general contract of the <code>readUnsignedShort</code>
+* See the general contract of the {@code readUnsignedShort}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next two bytes of this input stream, interpreted as an
 *             unsigned 16-bit integer.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *             reading two bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final int readUnsignedShort() throws IOException {
 throw new EOFException();
 return (ch1 << 8) + (ch2 << 0);
 }
 /**
-* See the general contract of the <code>readChar</code>
+* See the general contract of the {@code readChar}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next two bytes of this input stream, interpreted as a
-*             <code>char</code>.
+*             {@code char}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading two bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final char readChar() throws IOException {
 throw new EOFException();
 return (char)((ch1 << 8) + (ch2 << 0));
 }
 /**
-* See the general contract of the <code>readInt</code>
+* See the general contract of the {@code readInt}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next four bytes of this input stream, interpreted as an
-*             <code>int</code>.
+*             {@code int}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading four bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final int readInt() throws IOException {
 }
 private byte readBuffer[] = new byte[8];
 /**
-* See the general contract of the <code>readLong</code>
+* See the general contract of the {@code readLong}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next eight bytes of this input stream, interpreted as a
-*             <code>long</code>.
+*             {@code long}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading eight bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.FilterInputStream#in
 */
 public final long readLong() throws IOException {
 ((readBuffer[6] & 255) <<  8) +
 ((readBuffer[7] & 255) <<  0));
 }
 /**
-* See the general contract of the <code>readFloat</code>
+* See the general contract of the {@code readFloat}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next four bytes of this input stream, interpreted as a
-*             <code>float</code>.
+*             {@code float}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading four bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.DataInputStream#readInt()
 * @see        java.lang.Float#intBitsToFloat(int)
 */
 public final float readFloat() throws IOException {
 return Float.intBitsToFloat(readInt());
 }
 /**
-* See the general contract of the <code>readDouble</code>
+* See the general contract of the {@code readDouble}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     the next eight bytes of this input stream, interpreted as a
-*             <code>double</code>.
+*             {@code double}.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading eight bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
 * @see        java.io.DataInputStream#readLong()
 * @see        java.lang.Double#longBitsToDouble(long)
 */
 }
 private char lineBuffer[];
 /**
-* See the general contract of the <code>readLine</code>
+* See the general contract of the {@code readLine}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @deprecated This method does not properly convert bytes to characters.
 * As of JDK&nbsp;1.1, the preferred way to read lines of text is via the
-* <code>BufferedReader.readLine()</code> method.  Programs that use the
+* {@code BufferedReader.readLine()} method.  Programs that use the
-* <code>DataInputStream</code> class to read lines can be converted to use
+* {@code DataInputStream} class to read lines can be converted to use
-* the <code>BufferedReader</code> class by replacing code of the form:
+* the {@code BufferedReader} class by replacing code of the form:
 * <blockquote><pre>
 *     DataInputStream d =&nbsp;new&nbsp;DataInputStream(in);
 * </pre></blockquote>
 * with:
 * <blockquote><pre>
 *     BufferedReader d
 *          =&nbsp;new&nbsp;BufferedReader(new&nbsp;InputStreamReader(in));
 * </pre></blockquote>
 *
 * @return     the next line of text from this input stream.
-* @exception  IOException  if an I/O error occurs.
+* @throws     IOException  if an I/O error occurs.
 * @see        java.io.BufferedReader#readLine()
 * @see        java.io.FilterInputStream#in
 */
 @Deprecated
 public final String readLine() throws IOException {
 }
 return String.copyValueOf(buf, 0, offset);
 }
 /**
-* See the general contract of the <code>readUTF</code>
+* See the general contract of the {@code readUTF}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 * <p>
 * Bytes
 * for this operation are read from the contained
 * input stream.
 *
 * @return     a Unicode string.
-* @exception  EOFException  if this input stream reaches the end before
+* @throws     EOFException  if this input stream reaches the end before
 *               reading all the bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
-* @exception  UTFDataFormatException if the bytes do not represent a valid
+* @throws     UTFDataFormatException if the bytes do not represent a valid
 *             modified UTF-8 encoding of a string.
 * @see        java.io.DataInputStream#readUTF(java.io.DataInput)
 */
 public final String readUTF() throws IOException {
 return readUTF(this);
 }
 /**
 * Reads from the
-* stream <code>in</code> a representation
+* stream {@code in} a representation
 * of a Unicode  character string encoded in
 * <a href="DataInput.html#modified-utf-8">modified UTF-8</a> format;
-* this string of characters is then returned as a <code>String</code>.
+* this string of characters is then returned as a {@code String}.
 * The details of the modified UTF-8 representation
-* are  exactly the same as for the <code>readUTF</code>
+* are  exactly the same as for the {@code readUTF}
-* method of <code>DataInput</code>.
+* method of {@code DataInput}.
 *
 * @param      in   a data input stream.
 * @return     a Unicode string.
-* @exception  EOFException            if the input stream reaches the end
+* @throws     EOFException            if the input stream reaches the end
 *               before all the bytes.
-* @exception  IOException   the stream has been closed and the contained
+* @throws     IOException   the stream has been closed and the contained
 *             input stream does not support reading after close, or
 *             another I/O error occurs.
-* @exception  UTFDataFormatException  if the bytes do not represent a
+* @throws     UTFDataFormatException  if the bytes do not represent a
 *               valid modified UTF-8 encoding of a Unicode string.
 * @see        java.io.DataInputStream#readUnsignedShort()
 */
 public static final String readUTF(DataInput in) throws IOException {
 int utflen = in.readUnsignedShort();

branch	datagramsocketimpl-branch
changeset 58678	9cf78a70fa4f
parent 47216	71c04702a3d5
child 58679	9c3209ff7550