8016370: javadoc warnings, unexpected </p> mostly
Reviewed-by: martin, jjg
This commit is contained in:
parent
0df3d2fa1a
commit
fdab7e6338
@ -70,7 +70,7 @@ __END__
|
||||
private $ARG_TYPE $ARG_ID;
|
||||
|
||||
/**
|
||||
* Constructs an instance of this class. </p>
|
||||
* Constructs an instance of this class.
|
||||
*
|
||||
* @param $ARG_ID
|
||||
* The $ARG_PHRASE
|
||||
@ -81,7 +81,7 @@ __END__
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the $ARG_PHRASE. </p>
|
||||
* Retrieves the $ARG_PHRASE.
|
||||
*
|
||||
* @return The $ARG_PHRASE
|
||||
*/
|
||||
|
@ -209,7 +209,7 @@ public abstract class Buffer {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this buffer's capacity. </p>
|
||||
* Returns this buffer's capacity.
|
||||
*
|
||||
* @return The capacity of this buffer
|
||||
*/
|
||||
@ -218,7 +218,7 @@ public abstract class Buffer {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this buffer's position. </p>
|
||||
* Returns this buffer's position.
|
||||
*
|
||||
* @return The position of this buffer
|
||||
*/
|
||||
@ -228,7 +228,7 @@ public abstract class Buffer {
|
||||
|
||||
/**
|
||||
* Sets this buffer's position. If the mark is defined and larger than the
|
||||
* new position then it is discarded. </p>
|
||||
* new position then it is discarded.
|
||||
*
|
||||
* @param newPosition
|
||||
* The new position value; must be non-negative
|
||||
@ -248,7 +248,7 @@ public abstract class Buffer {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this buffer's limit. </p>
|
||||
* Returns this buffer's limit.
|
||||
*
|
||||
* @return The limit of this buffer
|
||||
*/
|
||||
@ -259,7 +259,7 @@ public abstract class Buffer {
|
||||
/**
|
||||
* Sets this buffer's limit. If the position is larger than the new limit
|
||||
* then it is set to the new limit. If the mark is defined and larger than
|
||||
* the new limit then it is discarded. </p>
|
||||
* the new limit then it is discarded.
|
||||
*
|
||||
* @param newLimit
|
||||
* The new limit value; must be non-negative
|
||||
@ -280,7 +280,7 @@ public abstract class Buffer {
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets this buffer's mark at its position. </p>
|
||||
* Sets this buffer's mark at its position.
|
||||
*
|
||||
* @return This buffer
|
||||
*/
|
||||
@ -383,7 +383,7 @@ public abstract class Buffer {
|
||||
|
||||
/**
|
||||
* Returns the number of elements between the current position and the
|
||||
* limit. </p>
|
||||
* limit.
|
||||
*
|
||||
* @return The number of elements remaining in this buffer
|
||||
*/
|
||||
@ -393,7 +393,7 @@ public abstract class Buffer {
|
||||
|
||||
/**
|
||||
* Tells whether there are any elements between the current position and
|
||||
* the limit. </p>
|
||||
* the limit.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, there is at least one element
|
||||
* remaining in this buffer
|
||||
@ -403,7 +403,7 @@ public abstract class Buffer {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this buffer is read-only. </p>
|
||||
* Tells whether or not this buffer is read-only.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this buffer is read-only
|
||||
*/
|
||||
@ -477,7 +477,7 @@ public abstract class Buffer {
|
||||
|
||||
/**
|
||||
* Tells whether or not this buffer is
|
||||
* <a href="ByteBuffer.html#direct"><i>direct</i></a>. </p>
|
||||
* <a href="ByteBuffer.html#direct"><i>direct</i></a>.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this buffer is direct
|
||||
*
|
||||
@ -491,7 +491,7 @@ public abstract class Buffer {
|
||||
/**
|
||||
* Checks the current position against the limit, throwing a {@link
|
||||
* BufferUnderflowException} if it is not smaller than the limit, and then
|
||||
* increments the position. </p>
|
||||
* increments the position.
|
||||
*
|
||||
* @return The current position value, before it is incremented
|
||||
*/
|
||||
@ -512,7 +512,7 @@ public abstract class Buffer {
|
||||
/**
|
||||
* Checks the current position against the limit, throwing a {@link
|
||||
* BufferOverflowException} if it is not smaller than the limit, and then
|
||||
* increments the position. </p>
|
||||
* increments the position.
|
||||
*
|
||||
* @return The current position value, before it is incremented
|
||||
*/
|
||||
|
@ -45,7 +45,6 @@ public final class ByteOrder {
|
||||
/**
|
||||
* Constant denoting big-endian byte order. In this order, the bytes of a
|
||||
* multibyte value are ordered from most significant to least significant.
|
||||
* </p>
|
||||
*/
|
||||
public static final ByteOrder BIG_ENDIAN
|
||||
= new ByteOrder("BIG_ENDIAN");
|
||||
@ -53,7 +52,7 @@ public final class ByteOrder {
|
||||
/**
|
||||
* Constant denoting little-endian byte order. In this order, the bytes of
|
||||
* a multibyte value are ordered from least significant to most
|
||||
* significant. </p>
|
||||
* significant.
|
||||
*/
|
||||
public static final ByteOrder LITTLE_ENDIAN
|
||||
= new ByteOrder("LITTLE_ENDIAN");
|
||||
|
@ -551,7 +551,7 @@ public abstract class $Type$Buffer
|
||||
|
||||
/**
|
||||
* Relative <i>get</i> method. Reads the $type$ at this buffer's
|
||||
* current position, and then increments the position. </p>
|
||||
* current position, and then increments the position.
|
||||
*
|
||||
* @return The $type$ at the buffer's current position
|
||||
*
|
||||
@ -581,7 +581,7 @@ public abstract class $Type$Buffer
|
||||
|
||||
/**
|
||||
* Absolute <i>get</i> method. Reads the $type$ at the given
|
||||
* index. </p>
|
||||
* index.
|
||||
*
|
||||
* @param index
|
||||
* The index from which the $type$ will be read
|
||||
@ -658,7 +658,7 @@ public abstract class $Type$Buffer
|
||||
* }</pre>
|
||||
*
|
||||
* except that it first checks that there are sufficient $type$s in
|
||||
* this buffer and it is potentially much more efficient. </p>
|
||||
* this buffer and it is potentially much more efficient.
|
||||
*
|
||||
* @param dst
|
||||
* The array into which $type$s are to be written
|
||||
@ -739,7 +739,7 @@ public abstract class $Type$Buffer
|
||||
* dst.put(src.get()); </pre>
|
||||
*
|
||||
* except that it first checks that there is sufficient space in this
|
||||
* buffer and it is potentially much more efficient. </p>
|
||||
* buffer and it is potentially much more efficient.
|
||||
*
|
||||
* @param src
|
||||
* The source buffer from which $type$s are to be read;
|
||||
@ -795,7 +795,7 @@ public abstract class $Type$Buffer
|
||||
* }</pre>
|
||||
*
|
||||
* except that it first checks that there is sufficient space in this
|
||||
* buffer and it is potentially much more efficient. </p>
|
||||
* buffer and it is potentially much more efficient.
|
||||
*
|
||||
* @param src
|
||||
* The array from which $type$s are to be read
|
||||
@ -882,7 +882,7 @@ public abstract class $Type$Buffer
|
||||
* }</pre>
|
||||
*
|
||||
* except that it first checks that there is sufficient space in this
|
||||
* buffer and it is potentially much more efficient. </p>
|
||||
* buffer and it is potentially much more efficient.
|
||||
*
|
||||
* @param src
|
||||
* The string from which $type$s are to be read
|
||||
@ -1060,7 +1060,7 @@ public abstract class $Type$Buffer
|
||||
public abstract $Type$Buffer compact();
|
||||
|
||||
/**
|
||||
* Tells whether or not this $type$ buffer is direct. </p>
|
||||
* Tells whether or not this $type$ buffer is direct.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this buffer is direct
|
||||
*/
|
||||
@ -1069,7 +1069,7 @@ public abstract class $Type$Buffer
|
||||
#if[!char]
|
||||
|
||||
/**
|
||||
* Returns a string summarizing the state of this buffer. </p>
|
||||
* Returns a string summarizing the state of this buffer.
|
||||
*
|
||||
* @return A summary string
|
||||
*/
|
||||
@ -1254,7 +1254,7 @@ public abstract class $Type$Buffer
|
||||
|
||||
/**
|
||||
* Reads the character at the given index relative to the current
|
||||
* position. </p>
|
||||
* position.
|
||||
*
|
||||
* @param index
|
||||
* The index of the character to be read, relative to the position;
|
||||
@ -1452,7 +1452,7 @@ public abstract class $Type$Buffer
|
||||
}
|
||||
|
||||
/**
|
||||
* Modifies this buffer's byte order. </p>
|
||||
* Modifies this buffer's byte order.
|
||||
*
|
||||
* @param bo
|
||||
* The new byte order,
|
||||
|
@ -253,7 +253,7 @@ public abstract class AsynchronousServerSocketChannel
|
||||
* <p> To allow for concurrent handling of new connections, the completion
|
||||
* handler is not invoked directly by the initiating thread when a new
|
||||
* connection is accepted immediately (see <a
|
||||
* href="AsynchronousChannelGroup.html#threading">Threading<a>).
|
||||
* href="AsynchronousChannelGroup.html#threading">Threading</a>).
|
||||
*
|
||||
* <p> If a security manager has been installed then it verifies that the
|
||||
* address and port number of the connection's remote endpoint are permitted
|
||||
|
@ -56,7 +56,7 @@ import java.io.Closeable;
|
||||
public interface Channel extends Closeable {
|
||||
|
||||
/**
|
||||
* Tells whether or not this channel is open. </p>
|
||||
* Tells whether or not this channel is open.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this channel is open
|
||||
*/
|
||||
|
@ -418,7 +418,7 @@ public abstract class FileChannel
|
||||
// -- Other operations --
|
||||
|
||||
/**
|
||||
* Returns this channel's file position. </p>
|
||||
* Returns this channel's file position.
|
||||
*
|
||||
* @return This channel's file position,
|
||||
* a non-negative integer counting the number of bytes
|
||||
@ -461,7 +461,7 @@ public abstract class FileChannel
|
||||
public abstract FileChannel position(long newPosition) throws IOException;
|
||||
|
||||
/**
|
||||
* Returns the current size of this channel's file. </p>
|
||||
* Returns the current size of this channel's file.
|
||||
*
|
||||
* @return The current size of this channel's file,
|
||||
* measured in bytes
|
||||
|
@ -124,7 +124,7 @@ public abstract class FileLock implements AutoCloseable {
|
||||
private final boolean shared;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of this class. </p>
|
||||
* Initializes a new instance of this class.
|
||||
*
|
||||
* @param channel
|
||||
* The file channel upon whose file this lock is held
|
||||
@ -249,7 +249,7 @@ public abstract class FileLock implements AutoCloseable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether this lock is shared. </p>
|
||||
* Tells whether this lock is shared.
|
||||
*
|
||||
* @return <tt>true</tt> if lock is shared,
|
||||
* <tt>false</tt> if it is exclusive
|
||||
@ -259,7 +259,7 @@ public abstract class FileLock implements AutoCloseable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this lock overlaps the given lock range. </p>
|
||||
* Tells whether or not this lock overlaps the given lock range.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this lock and the given lock
|
||||
* range overlap by at least one byte
|
||||
|
@ -53,7 +53,7 @@ import java.nio.channels.spi.*;
|
||||
public abstract class Pipe {
|
||||
|
||||
/**
|
||||
* A channel representing the readable end of a {@link Pipe}. </p>
|
||||
* A channel representing the readable end of a {@link Pipe}.
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
@ -84,7 +84,7 @@ public abstract class Pipe {
|
||||
}
|
||||
|
||||
/**
|
||||
* A channel representing the writable end of a {@link Pipe}. </p>
|
||||
* A channel representing the writable end of a {@link Pipe}.
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
@ -120,14 +120,14 @@ public abstract class Pipe {
|
||||
protected Pipe() { }
|
||||
|
||||
/**
|
||||
* Returns this pipe's source channel. </p>
|
||||
* Returns this pipe's source channel.
|
||||
*
|
||||
* @return This pipe's source channel
|
||||
*/
|
||||
public abstract SourceChannel source();
|
||||
|
||||
/**
|
||||
* Returns this pipe's sink channel. </p>
|
||||
* Returns this pipe's sink channel.
|
||||
*
|
||||
* @return This pipe's sink channel
|
||||
*/
|
||||
|
@ -111,7 +111,7 @@ public abstract class SelectableChannel
|
||||
* identifying this channel's supported operations. The bits that are set
|
||||
* in this integer value denote exactly the operations that are valid for
|
||||
* this channel. This method always returns the same value for a given
|
||||
* concrete channel class. </p>
|
||||
* concrete channel class.
|
||||
*
|
||||
* @return The valid-operation set
|
||||
*/
|
||||
@ -140,7 +140,7 @@ public abstract class SelectableChannel
|
||||
|
||||
/**
|
||||
* Retrieves the key representing the channel's registration with the given
|
||||
* selector. </p>
|
||||
* selector.
|
||||
*
|
||||
* @return The key returned when this channel was last registered with the
|
||||
* given selector, or <tt>null</tt> if this channel is not
|
||||
@ -333,7 +333,6 @@ public abstract class SelectableChannel
|
||||
* configureBlocking} and {@link #register register} methods synchronize.
|
||||
* This is often useful in the implementation of adaptors that require a
|
||||
* specific blocking mode to be maintained for a short period of time.
|
||||
* </p>
|
||||
*
|
||||
* @return The blocking-mode lock object
|
||||
*/
|
||||
|
@ -119,7 +119,7 @@ public abstract class SelectionKey {
|
||||
|
||||
/**
|
||||
* Returns the channel for which this key was created. This method will
|
||||
* continue to return the channel even after the key is cancelled. </p>
|
||||
* continue to return the channel even after the key is cancelled.
|
||||
*
|
||||
* @return This key's channel
|
||||
*/
|
||||
@ -127,7 +127,7 @@ public abstract class SelectionKey {
|
||||
|
||||
/**
|
||||
* Returns the selector for which this key was created. This method will
|
||||
* continue to return the selector even after the key is cancelled. </p>
|
||||
* continue to return the selector even after the key is cancelled.
|
||||
*
|
||||
* @return This key's selector
|
||||
*/
|
||||
@ -228,7 +228,7 @@ public abstract class SelectionKey {
|
||||
public static final int OP_READ = 1 << 0;
|
||||
|
||||
/**
|
||||
* Operation-set bit for write operations. </p>
|
||||
* Operation-set bit for write operations.
|
||||
*
|
||||
* <p> Suppose that a selection key's interest set contains
|
||||
* <tt>OP_WRITE</tt> at the start of a <a
|
||||
@ -241,7 +241,7 @@ public abstract class SelectionKey {
|
||||
public static final int OP_WRITE = 1 << 2;
|
||||
|
||||
/**
|
||||
* Operation-set bit for socket-connect operations. </p>
|
||||
* Operation-set bit for socket-connect operations.
|
||||
*
|
||||
* <p> Suppose that a selection key's interest set contains
|
||||
* <tt>OP_CONNECT</tt> at the start of a <a
|
||||
@ -254,7 +254,7 @@ public abstract class SelectionKey {
|
||||
public static final int OP_CONNECT = 1 << 3;
|
||||
|
||||
/**
|
||||
* Operation-set bit for socket-accept operations. </p>
|
||||
* Operation-set bit for socket-accept operations.
|
||||
*
|
||||
* <p> Suppose that a selection key's interest set contains
|
||||
* <tt>OP_ACCEPT</tt> at the start of a <a
|
||||
@ -319,7 +319,7 @@ public abstract class SelectionKey {
|
||||
* <p> An invocation of this method of the form <tt>k.isConnectable()</tt>
|
||||
* behaves in exactly the same way as the expression
|
||||
*
|
||||
* <blockqoute><pre>{@code
|
||||
* <blockquote><pre>{@code
|
||||
* k.readyOps() & OP_CONNECT != 0
|
||||
* }</pre></blockquote>
|
||||
*
|
||||
@ -389,7 +389,7 @@ public abstract class SelectionKey {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current attachment. </p>
|
||||
* Retrieves the current attachment.
|
||||
*
|
||||
* @return The object currently attached to this key,
|
||||
* or <tt>null</tt> if there is no attachment
|
||||
|
@ -228,14 +228,14 @@ public abstract class Selector implements Closeable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this selector is open. </p>
|
||||
* Tells whether or not this selector is open.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this selector is open
|
||||
*/
|
||||
public abstract boolean isOpen();
|
||||
|
||||
/**
|
||||
* Returns the provider that created this channel. </p>
|
||||
* Returns the provider that created this channel.
|
||||
*
|
||||
* @return The provider that created this channel
|
||||
*/
|
||||
|
@ -302,7 +302,7 @@ public abstract class SocketChannel
|
||||
|
||||
/**
|
||||
* Tells whether or not a connection operation is in progress on this
|
||||
* channel. </p>
|
||||
* channel.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, a connection operation has been
|
||||
* initiated on this channel but not yet completed by invoking the
|
||||
|
@ -43,7 +43,7 @@ public abstract class AbstractSelectionKey
|
||||
{
|
||||
|
||||
/**
|
||||
* Initializes a new instance of this class. </p>
|
||||
* Initializes a new instance of this class.
|
||||
*/
|
||||
protected AbstractSelectionKey() { }
|
||||
|
||||
|
@ -76,7 +76,7 @@ public abstract class AbstractSelector
|
||||
private final SelectorProvider provider;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of this class. </p>
|
||||
* Initializes a new instance of this class.
|
||||
*/
|
||||
protected AbstractSelector(SelectorProvider provider) {
|
||||
this.provider = provider;
|
||||
|
@ -72,7 +72,7 @@ public abstract class SelectorProvider {
|
||||
private static SelectorProvider provider = null;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of this class. </p>
|
||||
* Initializes a new instance of this class.
|
||||
*
|
||||
* @throws SecurityException
|
||||
* If a security manager has been installed and it denies
|
||||
@ -180,7 +180,7 @@ public abstract class SelectorProvider {
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a datagram channel. </p>
|
||||
* Opens a datagram channel.
|
||||
*
|
||||
* @return The new channel
|
||||
*/
|
||||
@ -206,7 +206,7 @@ public abstract class SelectorProvider {
|
||||
throws IOException;
|
||||
|
||||
/**
|
||||
* Opens a pipe. </p>
|
||||
* Opens a pipe.
|
||||
*
|
||||
* @return The new pipe
|
||||
*/
|
||||
@ -214,7 +214,7 @@ public abstract class SelectorProvider {
|
||||
throws IOException;
|
||||
|
||||
/**
|
||||
* Opens a selector. </p>
|
||||
* Opens a selector.
|
||||
*
|
||||
* @return The new selector
|
||||
*/
|
||||
@ -222,7 +222,7 @@ public abstract class SelectorProvider {
|
||||
throws IOException;
|
||||
|
||||
/**
|
||||
* Opens a server-socket channel. </p>
|
||||
* Opens a server-socket channel.
|
||||
*
|
||||
* @return The new channel
|
||||
*/
|
||||
@ -230,7 +230,7 @@ public abstract class SelectorProvider {
|
||||
throws IOException;
|
||||
|
||||
/**
|
||||
* Opens a socket channel. </p>
|
||||
* Opens a socket channel.
|
||||
*
|
||||
* @return The new channel
|
||||
*/
|
||||
|
@ -161,7 +161,7 @@ public abstract class Charset$Coder$ {
|
||||
|
||||
/**
|
||||
* Initializes a new $coder$. The new $coder$ will have the given
|
||||
* $otypes-per-itype$ and replacement values. </p>
|
||||
* $otypes-per-itype$ and replacement values.
|
||||
*
|
||||
* @param average$ItypesPerOtype$
|
||||
* A positive float value indicating the expected number of
|
||||
@ -207,7 +207,7 @@ public abstract class Charset$Coder$ {
|
||||
/**
|
||||
* Initializes a new $coder$. The new $coder$ will have the given
|
||||
* $otypes-per-itype$ values and its replacement will be the
|
||||
* $replTypeName$ $defaultReplName$. </p>
|
||||
* $replTypeName$ $defaultReplName$.
|
||||
*
|
||||
* @param average$ItypesPerOtype$
|
||||
* A positive float value indicating the expected number of
|
||||
@ -230,7 +230,7 @@ public abstract class Charset$Coder$ {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the charset that created this $coder$. </p>
|
||||
* Returns the charset that created this $coder$.
|
||||
*
|
||||
* @return This $coder$'s charset
|
||||
*/
|
||||
@ -239,7 +239,7 @@ public abstract class Charset$Coder$ {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this $coder$'s replacement value. </p>
|
||||
* Returns this $coder$'s replacement value.
|
||||
*
|
||||
* @return This $coder$'s current replacement,
|
||||
* which is never <tt>null</tt> and is never empty
|
||||
@ -351,7 +351,7 @@ public abstract class Charset$Coder$ {
|
||||
#end[encoder]
|
||||
|
||||
/**
|
||||
* Returns this $coder$'s current action for malformed-input errors. </p>
|
||||
* Returns this $coder$'s current action for malformed-input errors.
|
||||
*
|
||||
* @return The current malformed-input action, which is never <tt>null</tt>
|
||||
*/
|
||||
@ -360,7 +360,7 @@ public abstract class Charset$Coder$ {
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes this $coder$'s action for malformed-input errors. </p>
|
||||
* Changes this $coder$'s action for malformed-input errors.
|
||||
*
|
||||
* <p> This method invokes the {@link #implOnMalformedInput
|
||||
* implOnMalformedInput} method, passing the new action. </p>
|
||||
@ -391,7 +391,6 @@ public abstract class Charset$Coder$ {
|
||||
|
||||
/**
|
||||
* Returns this $coder$'s current action for unmappable-character errors.
|
||||
* </p>
|
||||
*
|
||||
* @return The current unmappable-character action, which is never
|
||||
* <tt>null</tt>
|
||||
@ -435,7 +434,7 @@ public abstract class Charset$Coder$ {
|
||||
/**
|
||||
* Returns the average number of $otype$s that will be produced for each
|
||||
* $itype$ of input. This heuristic value may be used to estimate the size
|
||||
* of the output buffer required for a given input sequence. </p>
|
||||
* of the output buffer required for a given input sequence.
|
||||
*
|
||||
* @return The average number of $otype$s produced
|
||||
* per $itype$ of input
|
||||
@ -447,7 +446,7 @@ public abstract class Charset$Coder$ {
|
||||
/**
|
||||
* Returns the maximum number of $otype$s that will be produced for each
|
||||
* $itype$ of input. This value may be used to compute the worst-case size
|
||||
* of the output buffer required for a given input sequence. </p>
|
||||
* of the output buffer required for a given input sequence.
|
||||
*
|
||||
* @return The maximum number of $otype$s that will be produced per
|
||||
* $itype$ of input
|
||||
|
@ -490,7 +490,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether the named charset is supported. </p>
|
||||
* Tells whether the named charset is supported.
|
||||
*
|
||||
* @param charsetName
|
||||
* The name of the requested charset; may be either
|
||||
@ -510,7 +510,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a charset object for the named charset. </p>
|
||||
* Returns a charset object for the named charset.
|
||||
*
|
||||
* @param charsetName
|
||||
* The name of the requested charset; may be either
|
||||
@ -629,7 +629,7 @@ public abstract class Charset
|
||||
|
||||
/**
|
||||
* Initializes a new charset with the given canonical name and alias
|
||||
* set. </p>
|
||||
* set.
|
||||
*
|
||||
* @param canonicalName
|
||||
* The canonical name of this charset
|
||||
@ -650,7 +650,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this charset's canonical name. </p>
|
||||
* Returns this charset's canonical name.
|
||||
*
|
||||
* @return The canonical name of this charset
|
||||
*/
|
||||
@ -659,7 +659,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a set containing this charset's aliases. </p>
|
||||
* Returns a set containing this charset's aliases.
|
||||
*
|
||||
* @return An immutable set of this charset's aliases
|
||||
*/
|
||||
@ -690,7 +690,7 @@ public abstract class Charset
|
||||
/**
|
||||
* Tells whether or not this charset is registered in the <a
|
||||
* href="http://www.iana.org/assignments/character-sets">IANA Charset
|
||||
* Registry</a>. </p>
|
||||
* Registry</a>.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this charset is known by its
|
||||
* implementor to be registered with the IANA
|
||||
@ -742,14 +742,14 @@ public abstract class Charset
|
||||
public abstract boolean contains(Charset cs);
|
||||
|
||||
/**
|
||||
* Constructs a new decoder for this charset. </p>
|
||||
* Constructs a new decoder for this charset.
|
||||
*
|
||||
* @return A new decoder for this charset
|
||||
*/
|
||||
public abstract CharsetDecoder newDecoder();
|
||||
|
||||
/**
|
||||
* Constructs a new encoder for this charset. </p>
|
||||
* Constructs a new encoder for this charset.
|
||||
*
|
||||
* @return A new encoder for this charset
|
||||
*
|
||||
@ -881,7 +881,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes a hashcode for this charset. </p>
|
||||
* Computes a hashcode for this charset.
|
||||
*
|
||||
* @return An integer hashcode
|
||||
*/
|
||||
@ -907,7 +907,7 @@ public abstract class Charset
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string describing this charset. </p>
|
||||
* Returns a string describing this charset.
|
||||
*
|
||||
* @return A string describing this charset
|
||||
*/
|
||||
|
@ -71,7 +71,7 @@ import java.util.HashMap;
|
||||
*
|
||||
* </ul>
|
||||
*
|
||||
* For convenience, the {@link #isError() isError} method returns <tt>true</tt>
|
||||
* <p> For convenience, the {@link #isError() isError} method returns <tt>true</tt>
|
||||
* for result objects that describe malformed-input and unmappable-character
|
||||
* errors but <tt>false</tt> for those that describe underflow or overflow
|
||||
* conditions. </p>
|
||||
@ -112,7 +112,7 @@ public class CoderResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this object describes an underflow condition. </p>
|
||||
* Tells whether or not this object describes an underflow condition.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this object denotes underflow
|
||||
*/
|
||||
@ -121,7 +121,7 @@ public class CoderResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this object describes an overflow condition. </p>
|
||||
* Tells whether or not this object describes an overflow condition.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this object denotes overflow
|
||||
*/
|
||||
@ -130,7 +130,7 @@ public class CoderResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether or not this object describes an error condition. </p>
|
||||
* Tells whether or not this object describes an error condition.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this object denotes either a
|
||||
* malformed-input error or an unmappable-character error
|
||||
@ -141,7 +141,6 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Tells whether or not this object describes a malformed-input error.
|
||||
* </p>
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this object denotes a
|
||||
* malformed-input error
|
||||
@ -152,7 +151,7 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Tells whether or not this object describes an unmappable-character
|
||||
* error. </p>
|
||||
* error.
|
||||
*
|
||||
* @return <tt>true</tt> if, and only if, this object denotes an
|
||||
* unmappable-character error
|
||||
@ -163,7 +162,7 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Returns the length of the erroneous input described by this
|
||||
* object <i>(optional operation)</i>. </p>
|
||||
* object <i>(optional operation)</i>.
|
||||
*
|
||||
* @return The length of the erroneous input, a positive integer
|
||||
*
|
||||
@ -180,14 +179,14 @@ public class CoderResult {
|
||||
/**
|
||||
* Result object indicating underflow, meaning that either the input buffer
|
||||
* has been completely consumed or, if the input buffer is not yet empty,
|
||||
* that additional input is required. </p>
|
||||
* that additional input is required.
|
||||
*/
|
||||
public static final CoderResult UNDERFLOW
|
||||
= new CoderResult(CR_UNDERFLOW, 0);
|
||||
|
||||
/**
|
||||
* Result object indicating overflow, meaning that there is insufficient
|
||||
* room in the output buffer. </p>
|
||||
* room in the output buffer.
|
||||
*/
|
||||
public static final CoderResult OVERFLOW
|
||||
= new CoderResult(CR_OVERFLOW, 0);
|
||||
@ -226,7 +225,7 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Static factory method that returns the unique object describing a
|
||||
* malformed-input error of the given length. </p>
|
||||
* malformed-input error of the given length.
|
||||
*
|
||||
* @return The requested coder-result object
|
||||
*/
|
||||
@ -242,7 +241,7 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Static factory method that returns the unique result object describing
|
||||
* an unmappable-character error of the given length. </p>
|
||||
* an unmappable-character error of the given length.
|
||||
*
|
||||
* @return The requested coder-result object
|
||||
*/
|
||||
@ -252,7 +251,6 @@ public class CoderResult {
|
||||
|
||||
/**
|
||||
* Throws an exception appropriate to the result described by this object.
|
||||
* </p>
|
||||
*
|
||||
* @throws BufferUnderflowException
|
||||
* If this object is {@link #UNDERFLOW}
|
||||
|
@ -50,7 +50,7 @@ public class CodingErrorAction {
|
||||
|
||||
/**
|
||||
* Action indicating that a coding error is to be handled by dropping the
|
||||
* erroneous input and resuming the coding operation. </p>
|
||||
* erroneous input and resuming the coding operation.
|
||||
*/
|
||||
public static final CodingErrorAction IGNORE
|
||||
= new CodingErrorAction("IGNORE");
|
||||
@ -58,7 +58,7 @@ public class CodingErrorAction {
|
||||
/**
|
||||
* Action indicating that a coding error is to be handled by dropping the
|
||||
* erroneous input, appending the coder's replacement value to the output
|
||||
* buffer, and resuming the coding operation. </p>
|
||||
* buffer, and resuming the coding operation.
|
||||
*/
|
||||
public static final CodingErrorAction REPLACE
|
||||
= new CodingErrorAction("REPLACE");
|
||||
@ -73,7 +73,7 @@ public class CodingErrorAction {
|
||||
= new CodingErrorAction("REPORT");
|
||||
|
||||
/**
|
||||
* Returns a string describing this action. </p>
|
||||
* Returns a string describing this action.
|
||||
*
|
||||
* @return A descriptive string
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@ package java.nio.charset;
|
||||
/**
|
||||
* Checked exception thrown when an input character (or byte) sequence
|
||||
* is valid but cannot be mapped to an output byte (or character)
|
||||
* sequence. </p>
|
||||
* sequence.
|
||||
*
|
||||
* @since 1.4
|
||||
*/
|
||||
|
@ -72,7 +72,7 @@ import java.util.Iterator;
|
||||
public abstract class CharsetProvider {
|
||||
|
||||
/**
|
||||
* Initializes a new charset provider. </p>
|
||||
* Initializes a new charset provider.
|
||||
*
|
||||
* @throws SecurityException
|
||||
* If a security manager has been installed and it denies
|
||||
@ -88,14 +88,14 @@ public abstract class CharsetProvider {
|
||||
* Creates an iterator that iterates over the charsets supported by this
|
||||
* provider. This method is used in the implementation of the {@link
|
||||
* java.nio.charset.Charset#availableCharsets Charset.availableCharsets}
|
||||
* method. </p>
|
||||
* method.
|
||||
*
|
||||
* @return The new iterator
|
||||
*/
|
||||
public abstract Iterator<Charset> charsets();
|
||||
|
||||
/**
|
||||
* Retrieves a charset for the given charset name. </p>
|
||||
* Retrieves a charset for the given charset name.
|
||||
*
|
||||
* @param charsetName
|
||||
* The name of the requested charset; may be either
|
||||
|
Loading…
x
Reference in New Issue
Block a user