8020091: Fix HTML doclint issues in java.io
Reviewed-by: darcy
This commit is contained in:
parent
6085f712f8
commit
dfb135dd14
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 1995, 2012, Oracle and/or its affiliates. All rights reserved.
|
* Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||||
*
|
*
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
* This code is free software; you can redistribute it and/or modify it
|
||||||
@ -66,10 +66,10 @@ package java.io;
|
|||||||
* summary="Bit values and bytes">
|
* summary="Bit values and bytes">
|
||||||
* <tr>
|
* <tr>
|
||||||
* <td></td>
|
* <td></td>
|
||||||
* <th id="bit">Bit Values</th>
|
* <th id="bit_a">Bit Values</th>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <th id="byte1">Byte 1</th>
|
* <th id="byte1_a">Byte 1</th>
|
||||||
* <td>
|
* <td>
|
||||||
* <table border="1" cellspacing="0" width="100%">
|
* <table border="1" cellspacing="0" width="100%">
|
||||||
* <tr>
|
* <tr>
|
||||||
@ -92,10 +92,10 @@ package java.io;
|
|||||||
* summary="Bit values and bytes">
|
* summary="Bit values and bytes">
|
||||||
* <tr>
|
* <tr>
|
||||||
* <td></td>
|
* <td></td>
|
||||||
* <th id="bit">Bit Values</th>
|
* <th id="bit_b">Bit Values</th>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <th id="byte1">Byte 1</th>
|
* <th id="byte1_b">Byte 1</th>
|
||||||
* <td>
|
* <td>
|
||||||
* <table border="1" cellspacing="0" width="100%">
|
* <table border="1" cellspacing="0" width="100%">
|
||||||
* <tr>
|
* <tr>
|
||||||
@ -108,7 +108,7 @@ package java.io;
|
|||||||
* </td>
|
* </td>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <th id="byte2">Byte 2</th>
|
* <th id="byte2_a">Byte 2</th>
|
||||||
* <td>
|
* <td>
|
||||||
* <table border="1" cellspacing="0" width="100%">
|
* <table border="1" cellspacing="0" width="100%">
|
||||||
* <tr>
|
* <tr>
|
||||||
@ -131,10 +131,10 @@ package java.io;
|
|||||||
* summary="Bit values and bytes">
|
* summary="Bit values and bytes">
|
||||||
* <tr>
|
* <tr>
|
||||||
* <td></td>
|
* <td></td>
|
||||||
* <th id="bit">Bit Values</th>
|
* <th id="bit_c">Bit Values</th>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <th id="byte1">Byte 1</th>
|
* <th id="byte1_c">Byte 1</th>
|
||||||
* <td>
|
* <td>
|
||||||
* <table border="1" cellspacing="0" width="100%">
|
* <table border="1" cellspacing="0" width="100%">
|
||||||
* <tr>
|
* <tr>
|
||||||
@ -148,7 +148,7 @@ package java.io;
|
|||||||
* </td>
|
* </td>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <th id="byte2">Byte 2</th>
|
* <th id="byte2_b">Byte 2</th>
|
||||||
* <td>
|
* <td>
|
||||||
* <table border="1" cellspacing="0" width="100%">
|
* <table border="1" cellspacing="0" width="100%">
|
||||||
* <tr>
|
* <tr>
|
||||||
|
@ -331,7 +331,7 @@ class FileInputStream extends InputStream
|
|||||||
* object associated with this file input stream.
|
* object associated with this file input stream.
|
||||||
*
|
*
|
||||||
* <p> The initial {@link java.nio.channels.FileChannel#position()
|
* <p> The initial {@link java.nio.channels.FileChannel#position()
|
||||||
* </code>position<code>} of the returned channel will be equal to the
|
* position} of the returned channel will be equal to the
|
||||||
* number of bytes read from the file so far. Reading bytes from this
|
* number of bytes read from the file so far. Reading bytes from this
|
||||||
* stream will increment the channel's position. Changing the channel's
|
* stream will increment the channel's position. Changing the channel's
|
||||||
* position, either explicitly or by reading, will change this stream's
|
* position, either explicitly or by reading, will change this stream's
|
||||||
|
@ -358,10 +358,10 @@ class FileOutputStream extends OutputStream
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the unique {@link java.nio.channels.FileChannel FileChannel}
|
* Returns the unique {@link java.nio.channels.FileChannel FileChannel}
|
||||||
* object associated with this file output stream. </p>
|
* object associated with this file output stream.
|
||||||
*
|
*
|
||||||
* <p> The initial {@link java.nio.channels.FileChannel#position()
|
* <p> The initial {@link java.nio.channels.FileChannel#position()
|
||||||
* </code>position<code>} of the returned channel will be equal to the
|
* position} of the returned channel will be equal to the
|
||||||
* number of bytes written to the file so far unless this stream is in
|
* number of bytes written to the file so far unless this stream is in
|
||||||
* append mode, in which case it will be equal to the size of the file.
|
* append mode, in which case it will be equal to the size of the file.
|
||||||
* Writing bytes to this stream will increment the channel's position
|
* Writing bytes to this stream will increment the channel's position
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 1996, 2012, Oracle and/or its affiliates. All rights reserved.
|
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||||
*
|
*
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
* This code is free software; you can redistribute it and/or modify it
|
||||||
@ -33,7 +33,7 @@ import sun.nio.cs.StreamDecoder;
|
|||||||
/**
|
/**
|
||||||
* An InputStreamReader is a bridge from byte streams to character streams: It
|
* An InputStreamReader is a bridge from byte streams to character streams: It
|
||||||
* reads bytes and decodes them into characters using a specified {@link
|
* reads bytes and decodes them into characters using a specified {@link
|
||||||
* java.nio.charset.Charset <code>charset</code>}. The charset that it uses
|
* java.nio.charset.Charset charset}. The charset that it uses
|
||||||
* may be specified by name or may be given explicitly, or the platform's
|
* may be specified by name or may be given explicitly, or the platform's
|
||||||
* default charset may be accepted.
|
* default charset may be accepted.
|
||||||
*
|
*
|
||||||
@ -101,7 +101,7 @@ public class InputStreamReader extends Reader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an InputStreamReader that uses the given charset. </p>
|
* Creates an InputStreamReader that uses the given charset.
|
||||||
*
|
*
|
||||||
* @param in An InputStream
|
* @param in An InputStream
|
||||||
* @param cs A charset
|
* @param cs A charset
|
||||||
@ -117,7 +117,7 @@ public class InputStreamReader extends Reader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an InputStreamReader that uses the given charset decoder. </p>
|
* Creates an InputStreamReader that uses the given charset decoder.
|
||||||
*
|
*
|
||||||
* @param in An InputStream
|
* @param in An InputStream
|
||||||
* @param dec A charset decoder
|
* @param dec A charset decoder
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
|
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||||
*
|
*
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
* This code is free software; you can redistribute it and/or modify it
|
||||||
@ -33,7 +33,7 @@ import sun.nio.cs.StreamEncoder;
|
|||||||
/**
|
/**
|
||||||
* An OutputStreamWriter is a bridge from character streams to byte streams:
|
* An OutputStreamWriter is a bridge from character streams to byte streams:
|
||||||
* Characters written to it are encoded into bytes using a specified {@link
|
* Characters written to it are encoded into bytes using a specified {@link
|
||||||
* java.nio.charset.Charset <code>charset</code>}. The charset that it uses
|
* java.nio.charset.Charset charset}. The charset that it uses
|
||||||
* may be specified by name or may be given explicitly, or the platform's
|
* may be specified by name or may be given explicitly, or the platform's
|
||||||
* default charset may be accepted.
|
* default charset may be accepted.
|
||||||
*
|
*
|
||||||
@ -86,7 +86,7 @@ public class OutputStreamWriter extends Writer {
|
|||||||
*
|
*
|
||||||
* @param charsetName
|
* @param charsetName
|
||||||
* The name of a supported
|
* The name of a supported
|
||||||
* {@link java.nio.charset.Charset </code>charset<code>}
|
* {@link java.nio.charset.Charset charset}
|
||||||
*
|
*
|
||||||
* @exception UnsupportedEncodingException
|
* @exception UnsupportedEncodingException
|
||||||
* If the named encoding is not supported
|
* If the named encoding is not supported
|
||||||
@ -115,7 +115,7 @@ public class OutputStreamWriter extends Writer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an OutputStreamWriter that uses the given charset. </p>
|
* Creates an OutputStreamWriter that uses the given charset.
|
||||||
*
|
*
|
||||||
* @param out
|
* @param out
|
||||||
* An OutputStream
|
* An OutputStream
|
||||||
@ -134,7 +134,7 @@ public class OutputStreamWriter extends Writer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an OutputStreamWriter that uses the given charset encoder. </p>
|
* Creates an OutputStreamWriter that uses the given charset encoder.
|
||||||
*
|
*
|
||||||
* @param out
|
* @param out
|
||||||
* An OutputStream
|
* An OutputStream
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (c) 1995, 2006, Oracle and/or its affiliates. All rights reserved.
|
* Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||||
*
|
*
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
* This code is free software; you can redistribute it and/or modify it
|
||||||
@ -39,7 +39,7 @@ package java.io;
|
|||||||
* The piped input stream contains a buffer,
|
* The piped input stream contains a buffer,
|
||||||
* decoupling read operations from write operations,
|
* decoupling read operations from write operations,
|
||||||
* within limits.
|
* within limits.
|
||||||
* A pipe is said to be <a name=BROKEN> <i>broken</i> </a> if a
|
* A pipe is said to be <a name="BROKEN"> <i>broken</i> </a> if a
|
||||||
* thread that was providing data bytes to the connected
|
* thread that was providing data bytes to the connected
|
||||||
* piped output stream is no longer alive.
|
* piped output stream is no longer alive.
|
||||||
*
|
*
|
||||||
@ -193,7 +193,7 @@ public class PipedInputStream extends InputStream {
|
|||||||
* Receives a byte of data. This method will block if no input is
|
* Receives a byte of data. This method will block if no input is
|
||||||
* available.
|
* available.
|
||||||
* @param b the byte being received
|
* @param b the byte being received
|
||||||
* @exception IOException If the pipe is <a href=#BROKEN> <code>broken</code></a>,
|
* @exception IOException If the pipe is <a href="#BROKEN"> <code>broken</code></a>,
|
||||||
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
||||||
* closed, or if an I/O error occurs.
|
* closed, or if an I/O error occurs.
|
||||||
* @since JDK1.1
|
* @since JDK1.1
|
||||||
@ -219,7 +219,7 @@ public class PipedInputStream extends InputStream {
|
|||||||
* @param b the buffer into which the data is received
|
* @param b the buffer into which the data is received
|
||||||
* @param off the start offset of the data
|
* @param off the start offset of the data
|
||||||
* @param len the maximum number of bytes received
|
* @param len the maximum number of bytes received
|
||||||
* @exception IOException If the pipe is <a href=#BROKEN> broken</a>,
|
* @exception IOException If the pipe is <a href="#BROKEN"> broken</a>,
|
||||||
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
||||||
* closed,or if an I/O error occurs.
|
* closed,or if an I/O error occurs.
|
||||||
*/
|
*/
|
||||||
@ -298,7 +298,7 @@ public class PipedInputStream extends InputStream {
|
|||||||
* stream is reached.
|
* stream is reached.
|
||||||
* @exception IOException if the pipe is
|
* @exception IOException if the pipe is
|
||||||
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
||||||
* <a href=#BROKEN> <code>broken</code></a>, closed,
|
* <a href="#BROKEN"> <code>broken</code></a>, closed,
|
||||||
* or if an I/O error occurs.
|
* or if an I/O error occurs.
|
||||||
*/
|
*/
|
||||||
public synchronized int read() throws IOException {
|
public synchronized int read() throws IOException {
|
||||||
@ -361,7 +361,7 @@ public class PipedInputStream extends InputStream {
|
|||||||
* @exception IndexOutOfBoundsException If <code>off</code> is negative,
|
* @exception IndexOutOfBoundsException If <code>off</code> is negative,
|
||||||
* <code>len</code> is negative, or <code>len</code> is greater than
|
* <code>len</code> is negative, or <code>len</code> is greater than
|
||||||
* <code>b.length - off</code>
|
* <code>b.length - off</code>
|
||||||
* @exception IOException if the pipe is <a href=#BROKEN> <code>broken</code></a>,
|
* @exception IOException if the pipe is <a href="#BROKEN"> <code>broken</code></a>,
|
||||||
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
* {@link #connect(java.io.PipedOutputStream) unconnected},
|
||||||
* closed, or if an I/O error occurs.
|
* closed, or if an I/O error occurs.
|
||||||
*/
|
*/
|
||||||
@ -419,7 +419,7 @@ public class PipedInputStream extends InputStream {
|
|||||||
* without blocking, or {@code 0} if this input stream has been
|
* without blocking, or {@code 0} if this input stream has been
|
||||||
* closed by invoking its {@link #close()} method, or if the pipe
|
* closed by invoking its {@link #close()} method, or if the pipe
|
||||||
* is {@link #connect(java.io.PipedOutputStream) unconnected}, or
|
* is {@link #connect(java.io.PipedOutputStream) unconnected}, or
|
||||||
* <a href=#BROKEN> <code>broken</code></a>.
|
* <a href="#BROKEN"> <code>broken</code></a>.
|
||||||
*
|
*
|
||||||
* @exception IOException if an I/O error occurs.
|
* @exception IOException if an I/O error occurs.
|
||||||
* @since JDK1.0.2
|
* @since JDK1.0.2
|
||||||
|
@ -123,11 +123,11 @@ public class RandomAccessFile implements DataOutput, DataInput, Closeable {
|
|||||||
* write to, the file specified by the {@link File} argument. A new {@link
|
* write to, the file specified by the {@link File} argument. A new {@link
|
||||||
* FileDescriptor} object is created to represent this file connection.
|
* FileDescriptor} object is created to represent this file connection.
|
||||||
*
|
*
|
||||||
* <a name="mode"><p> The <tt>mode</tt> argument specifies the access mode
|
* <p>The <a name="mode"><tt>mode</tt></a> argument specifies the access mode
|
||||||
* in which the file is to be opened. The permitted values and their
|
* in which the file is to be opened. The permitted values and their
|
||||||
* meanings are:
|
* meanings are:
|
||||||
*
|
*
|
||||||
* <blockquote><table summary="Access mode permitted values and meanings">
|
* <table summary="Access mode permitted values and meanings">
|
||||||
* <tr><th><p align="left">Value</p></th><th><p align="left">Meaning</p></th></tr>
|
* <tr><th><p align="left">Value</p></th><th><p align="left">Meaning</p></th></tr>
|
||||||
* <tr><td valign="top"><tt>"r"</tt></td>
|
* <tr><td valign="top"><tt>"r"</tt></td>
|
||||||
* <td> Open for reading only. Invoking any of the <tt>write</tt>
|
* <td> Open for reading only. Invoking any of the <tt>write</tt>
|
||||||
@ -144,7 +144,7 @@ public class RandomAccessFile implements DataOutput, DataInput, Closeable {
|
|||||||
* <td> Open for reading and writing, as with <tt>"rw"</tt>, and also
|
* <td> Open for reading and writing, as with <tt>"rw"</tt>, and also
|
||||||
* require that every update to the file's content be written
|
* require that every update to the file's content be written
|
||||||
* synchronously to the underlying storage device. </td></tr>
|
* synchronously to the underlying storage device. </td></tr>
|
||||||
* </table></blockquote>
|
* </table>
|
||||||
*
|
*
|
||||||
* The <tt>"rws"</tt> and <tt>"rwd"</tt> modes work much like the {@link
|
* The <tt>"rws"</tt> and <tt>"rwd"</tt> modes work much like the {@link
|
||||||
* java.nio.channels.FileChannel#force(boolean) force(boolean)} method of
|
* java.nio.channels.FileChannel#force(boolean) force(boolean)} method of
|
||||||
@ -158,13 +158,13 @@ public class RandomAccessFile implements DataOutput, DataInput, Closeable {
|
|||||||
* event of a system crash. If the file does not reside on a local device
|
* event of a system crash. If the file does not reside on a local device
|
||||||
* then no such guarantee is made.
|
* then no such guarantee is made.
|
||||||
*
|
*
|
||||||
* <p> The <tt>"rwd"</tt> mode can be used to reduce the number of I/O
|
* <p>The <tt>"rwd"</tt> mode can be used to reduce the number of I/O
|
||||||
* operations performed. Using <tt>"rwd"</tt> only requires updates to the
|
* operations performed. Using <tt>"rwd"</tt> only requires updates to the
|
||||||
* file's content to be written to storage; using <tt>"rws"</tt> requires
|
* file's content to be written to storage; using <tt>"rws"</tt> requires
|
||||||
* updates to both the file's content and its metadata to be written, which
|
* updates to both the file's content and its metadata to be written, which
|
||||||
* generally requires at least one more low-level I/O operation.
|
* generally requires at least one more low-level I/O operation.
|
||||||
*
|
*
|
||||||
* <p> If there is a security manager, its {@code checkRead} method is
|
* <p>If there is a security manager, its {@code checkRead} method is
|
||||||
* called with the pathname of the {@code file} argument as its
|
* called with the pathname of the {@code file} argument as its
|
||||||
* argument to see if read access to the file is allowed. If the mode
|
* argument to see if read access to the file is allowed. If the mode
|
||||||
* allows writing, the security manager's {@code checkWrite} method is
|
* allows writing, the security manager's {@code checkWrite} method is
|
||||||
@ -238,7 +238,7 @@ public class RandomAccessFile implements DataOutput, DataInput, Closeable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the opaque file descriptor object associated with this
|
* Returns the opaque file descriptor object associated with this
|
||||||
* stream. </p>
|
* stream.
|
||||||
*
|
*
|
||||||
* @return the file descriptor object associated with this stream.
|
* @return the file descriptor object associated with this stream.
|
||||||
* @exception IOException if an I/O error occurs.
|
* @exception IOException if an I/O error occurs.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user