From f3e8355e9057a2b254c40191b137bdc594105602 Mon Sep 17 00:00:00 2001 From: alanb Date: Wed, 12 Jun 2013 08:04:11 +0100 Subject: [PATCH] 8016370: javadoc warnings, unexpected

mostly Reviewed-by: martin, jjg --- makefiles/scripts/genExceptions.sh | 4 ++-- src/share/classes/java/nio/Buffer.java | 24 +++++++++---------- src/share/classes/java/nio/ByteOrder.java | 3 +-- .../classes/java/nio/X-Buffer.java.template | 20 ++++++++-------- .../AsynchronousServerSocketChannel.java | 2 +- .../classes/java/nio/channels/Channel.java | 2 +- .../java/nio/channels/FileChannel.java | 4 ++-- .../classes/java/nio/channels/FileLock.java | 6 ++--- src/share/classes/java/nio/channels/Pipe.java | 8 +++---- .../java/nio/channels/SelectableChannel.java | 5 ++-- .../java/nio/channels/SelectionKey.java | 14 +++++------ .../classes/java/nio/channels/Selector.java | 4 ++-- .../java/nio/channels/SocketChannel.java | 2 +- .../channels/spi/AbstractSelectionKey.java | 2 +- .../nio/channels/spi/AbstractSelector.java | 2 +- .../nio/channels/spi/SelectorProvider.java | 12 +++++----- .../nio/charset/Charset-X-Coder.java.template | 17 +++++++------ .../classes/java/nio/charset/Charset.java | 20 ++++++++-------- .../classes/java/nio/charset/CoderResult.java | 22 ++++++++--------- .../java/nio/charset/CodingErrorAction.java | 6 ++--- .../charset/UnmappableCharacterException.java | 2 +- .../java/nio/charset/spi/CharsetProvider.java | 6 ++--- 22 files changed, 91 insertions(+), 96 deletions(-) diff --git a/makefiles/scripts/genExceptions.sh b/makefiles/scripts/genExceptions.sh index 5a43c8741..698e14518 100644 --- a/makefiles/scripts/genExceptions.sh +++ b/makefiles/scripts/genExceptions.sh @@ -70,7 +70,7 @@ __END__ private $ARG_TYPE $ARG_ID; /** - * Constructs an instance of this class.

+ * Constructs an instance of this class. * * @param $ARG_ID * The $ARG_PHRASE @@ -81,7 +81,7 @@ __END__ } /** - * Retrieves the $ARG_PHRASE.

+ * Retrieves the $ARG_PHRASE. * * @return The $ARG_PHRASE */ diff --git a/src/share/classes/java/nio/Buffer.java b/src/share/classes/java/nio/Buffer.java index 24d3cf8c5..068444a97 100644 --- a/src/share/classes/java/nio/Buffer.java +++ b/src/share/classes/java/nio/Buffer.java @@ -209,7 +209,7 @@ public abstract class Buffer { } /** - * Returns this buffer's capacity.

+ * Returns this buffer's capacity. * * @return The capacity of this buffer */ @@ -218,7 +218,7 @@ public abstract class Buffer { } /** - * Returns this buffer's position.

+ * 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.

+ * 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.

+ * 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.

+ * 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.

+ * 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.

+ * 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.

+ * the limit. * * @return true 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.

+ * Tells whether or not this buffer is read-only. * * @return true if, and only if, this buffer is read-only */ @@ -477,7 +477,7 @@ public abstract class Buffer { /** * Tells whether or not this buffer is - * direct.

+ * direct. * * @return true 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.

+ * 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.

+ * increments the position. * * @return The current position value, before it is incremented */ diff --git a/src/share/classes/java/nio/ByteOrder.java b/src/share/classes/java/nio/ByteOrder.java index aed6c0095..50c7f158b 100644 --- a/src/share/classes/java/nio/ByteOrder.java +++ b/src/share/classes/java/nio/ByteOrder.java @@ -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. - *

*/ 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.

+ * significant. */ public static final ByteOrder LITTLE_ENDIAN = new ByteOrder("LITTLE_ENDIAN"); diff --git a/src/share/classes/java/nio/X-Buffer.java.template b/src/share/classes/java/nio/X-Buffer.java.template index 738b18b51..c3037adb4 100644 --- a/src/share/classes/java/nio/X-Buffer.java.template +++ b/src/share/classes/java/nio/X-Buffer.java.template @@ -551,7 +551,7 @@ public abstract class $Type$Buffer /** * Relative get method. Reads the $type$ at this buffer's - * current position, and then increments the position.

+ * 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 get method. Reads the $type$ at the given - * index.

+ * index. * * @param index * The index from which the $type$ will be read @@ -658,7 +658,7 @@ public abstract class $Type$Buffer * } * * except that it first checks that there are sufficient $type$s in - * this buffer and it is potentially much more efficient.

+ * 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()); * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient.

+ * 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 * } * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient.

+ * 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 * } * * except that it first checks that there is sufficient space in this - * buffer and it is potentially much more efficient.

+ * 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.

+ * Tells whether or not this $type$ buffer is direct. * * @return true 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.

+ * 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.

+ * 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.

+ * Modifies this buffer's byte order. * * @param bo * The new byte order, diff --git a/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java b/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java index 471b53571..dc4551b3b 100644 --- a/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java +++ b/src/share/classes/java/nio/channels/AsynchronousServerSocketChannel.java @@ -253,7 +253,7 @@ public abstract class AsynchronousServerSocketChannel *

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 Threading). + * href="AsynchronousChannelGroup.html#threading">Threading). * *

If a security manager has been installed then it verifies that the * address and port number of the connection's remote endpoint are permitted diff --git a/src/share/classes/java/nio/channels/Channel.java b/src/share/classes/java/nio/channels/Channel.java index a20de123d..88d15ace6 100644 --- a/src/share/classes/java/nio/channels/Channel.java +++ b/src/share/classes/java/nio/channels/Channel.java @@ -56,7 +56,7 @@ import java.io.Closeable; public interface Channel extends Closeable { /** - * Tells whether or not this channel is open.

+ * Tells whether or not this channel is open. * * @return true if, and only if, this channel is open */ diff --git a/src/share/classes/java/nio/channels/FileChannel.java b/src/share/classes/java/nio/channels/FileChannel.java index b9fe83db0..02d9082d2 100644 --- a/src/share/classes/java/nio/channels/FileChannel.java +++ b/src/share/classes/java/nio/channels/FileChannel.java @@ -418,7 +418,7 @@ public abstract class FileChannel // -- Other operations -- /** - * Returns this channel's file position.

+ * 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.

+ * Returns the current size of this channel's file. * * @return The current size of this channel's file, * measured in bytes diff --git a/src/share/classes/java/nio/channels/FileLock.java b/src/share/classes/java/nio/channels/FileLock.java index 019b90222..e978af431 100644 --- a/src/share/classes/java/nio/channels/FileLock.java +++ b/src/share/classes/java/nio/channels/FileLock.java @@ -124,7 +124,7 @@ public abstract class FileLock implements AutoCloseable { private final boolean shared; /** - * Initializes a new instance of this class.

+ * 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.

+ * Tells whether this lock is shared. * * @return true if lock is shared, * false 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.

+ * Tells whether or not this lock overlaps the given lock range. * * @return true if, and only if, this lock and the given lock * range overlap by at least one byte diff --git a/src/share/classes/java/nio/channels/Pipe.java b/src/share/classes/java/nio/channels/Pipe.java index c4d7bce74..af0722e99 100644 --- a/src/share/classes/java/nio/channels/Pipe.java +++ b/src/share/classes/java/nio/channels/Pipe.java @@ -53,7 +53,7 @@ import java.nio.channels.spi.*; public abstract class Pipe { /** - * A channel representing the readable end of a {@link Pipe}.

+ * 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}.

+ * 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.

+ * Returns this pipe's source channel. * * @return This pipe's source channel */ public abstract SourceChannel source(); /** - * Returns this pipe's sink channel.

+ * Returns this pipe's sink channel. * * @return This pipe's sink channel */ diff --git a/src/share/classes/java/nio/channels/SelectableChannel.java b/src/share/classes/java/nio/channels/SelectableChannel.java index 35569e86e..7041c34e1 100644 --- a/src/share/classes/java/nio/channels/SelectableChannel.java +++ b/src/share/classes/java/nio/channels/SelectableChannel.java @@ -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.

+ * 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.

+ * selector. * * @return The key returned when this channel was last registered with the * given selector, or null 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. - *

* * @return The blocking-mode lock object */ diff --git a/src/share/classes/java/nio/channels/SelectionKey.java b/src/share/classes/java/nio/channels/SelectionKey.java index 2280cb9e2..7a0ab88ac 100644 --- a/src/share/classes/java/nio/channels/SelectionKey.java +++ b/src/share/classes/java/nio/channels/SelectionKey.java @@ -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.

+ * 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.

+ * 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.

+ * Operation-set bit for write operations. * *

Suppose that a selection key's interest set contains * OP_WRITE at the start of a + * Operation-set bit for socket-connect operations. * *

Suppose that a selection key's interest set contains * OP_CONNECT at the start of a + * Operation-set bit for socket-accept operations. * *

Suppose that a selection key's interest set contains * OP_ACCEPT at the start of a An invocation of this method of the form k.isConnectable() * behaves in exactly the same way as the expression * - *

{@code
+     * 
{@code
      * k.readyOps() & OP_CONNECT != 0
      * }
* @@ -389,7 +389,7 @@ public abstract class SelectionKey { } /** - * Retrieves the current attachment.

+ * Retrieves the current attachment. * * @return The object currently attached to this key, * or null if there is no attachment diff --git a/src/share/classes/java/nio/channels/Selector.java b/src/share/classes/java/nio/channels/Selector.java index f51b9ed9d..d4c200e69 100644 --- a/src/share/classes/java/nio/channels/Selector.java +++ b/src/share/classes/java/nio/channels/Selector.java @@ -228,14 +228,14 @@ public abstract class Selector implements Closeable { } /** - * Tells whether or not this selector is open.

+ * Tells whether or not this selector is open. * * @return true if, and only if, this selector is open */ public abstract boolean isOpen(); /** - * Returns the provider that created this channel.

+ * Returns the provider that created this channel. * * @return The provider that created this channel */ diff --git a/src/share/classes/java/nio/channels/SocketChannel.java b/src/share/classes/java/nio/channels/SocketChannel.java index d5f43ba77..d1274a026 100644 --- a/src/share/classes/java/nio/channels/SocketChannel.java +++ b/src/share/classes/java/nio/channels/SocketChannel.java @@ -302,7 +302,7 @@ public abstract class SocketChannel /** * Tells whether or not a connection operation is in progress on this - * channel.

+ * channel. * * @return true if, and only if, a connection operation has been * initiated on this channel but not yet completed by invoking the diff --git a/src/share/classes/java/nio/channels/spi/AbstractSelectionKey.java b/src/share/classes/java/nio/channels/spi/AbstractSelectionKey.java index 70a0693f9..bf5a4d7c2 100644 --- a/src/share/classes/java/nio/channels/spi/AbstractSelectionKey.java +++ b/src/share/classes/java/nio/channels/spi/AbstractSelectionKey.java @@ -43,7 +43,7 @@ public abstract class AbstractSelectionKey { /** - * Initializes a new instance of this class.

+ * Initializes a new instance of this class. */ protected AbstractSelectionKey() { } diff --git a/src/share/classes/java/nio/channels/spi/AbstractSelector.java b/src/share/classes/java/nio/channels/spi/AbstractSelector.java index daa10ad20..fea4b0972 100644 --- a/src/share/classes/java/nio/channels/spi/AbstractSelector.java +++ b/src/share/classes/java/nio/channels/spi/AbstractSelector.java @@ -76,7 +76,7 @@ public abstract class AbstractSelector private final SelectorProvider provider; /** - * Initializes a new instance of this class.

+ * Initializes a new instance of this class. */ protected AbstractSelector(SelectorProvider provider) { this.provider = provider; diff --git a/src/share/classes/java/nio/channels/spi/SelectorProvider.java b/src/share/classes/java/nio/channels/spi/SelectorProvider.java index 460e39ecb..62d4bf6ff 100644 --- a/src/share/classes/java/nio/channels/spi/SelectorProvider.java +++ b/src/share/classes/java/nio/channels/spi/SelectorProvider.java @@ -72,7 +72,7 @@ public abstract class SelectorProvider { private static SelectorProvider provider = null; /** - * Initializes a new instance of this class.

+ * 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.

+ * Opens a datagram channel. * * @return The new channel */ @@ -206,7 +206,7 @@ public abstract class SelectorProvider { throws IOException; /** - * Opens a pipe.

+ * Opens a pipe. * * @return The new pipe */ @@ -214,7 +214,7 @@ public abstract class SelectorProvider { throws IOException; /** - * Opens a selector.

+ * Opens a selector. * * @return The new selector */ @@ -222,7 +222,7 @@ public abstract class SelectorProvider { throws IOException; /** - * Opens a server-socket channel.

+ * Opens a server-socket channel. * * @return The new channel */ @@ -230,7 +230,7 @@ public abstract class SelectorProvider { throws IOException; /** - * Opens a socket channel.

+ * Opens a socket channel. * * @return The new channel */ diff --git a/src/share/classes/java/nio/charset/Charset-X-Coder.java.template b/src/share/classes/java/nio/charset/Charset-X-Coder.java.template index 8b115cc0f..34be4eb83 100644 --- a/src/share/classes/java/nio/charset/Charset-X-Coder.java.template +++ b/src/share/classes/java/nio/charset/Charset-X-Coder.java.template @@ -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.

+ * $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$.

+ * $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$.

+ * 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.

+ * Returns this $coder$'s replacement value. * * @return This $coder$'s current replacement, * which is never null 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.

+ * Returns this $coder$'s current action for malformed-input errors. * * @return The current malformed-input action, which is never null */ @@ -360,7 +360,7 @@ public abstract class Charset$Coder$ { } /** - * Changes this $coder$'s action for malformed-input errors.

+ * Changes this $coder$'s action for malformed-input errors. * *

This method invokes the {@link #implOnMalformedInput * implOnMalformedInput} method, passing the new action.

@@ -391,7 +391,6 @@ public abstract class Charset$Coder$ { /** * Returns this $coder$'s current action for unmappable-character errors. - *

* * @return The current unmappable-character action, which is never * null @@ -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.

+ * 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.

+ * 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 diff --git a/src/share/classes/java/nio/charset/Charset.java b/src/share/classes/java/nio/charset/Charset.java index 9451c537a..69c3ab0e1 100644 --- a/src/share/classes/java/nio/charset/Charset.java +++ b/src/share/classes/java/nio/charset/Charset.java @@ -490,7 +490,7 @@ public abstract class Charset } /** - * Tells whether the named charset is supported.

+ * 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.

+ * 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.

+ * set. * * @param canonicalName * The canonical name of this charset @@ -650,7 +650,7 @@ public abstract class Charset } /** - * Returns this charset's canonical name.

+ * 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.

+ * 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
IANA Charset - * Registry.

+ * Registry. * * @return true 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.

+ * 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.

+ * 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.

+ * Computes a hashcode for this charset. * * @return An integer hashcode */ @@ -907,7 +907,7 @@ public abstract class Charset } /** - * Returns a string describing this charset.

+ * Returns a string describing this charset. * * @return A string describing this charset */ diff --git a/src/share/classes/java/nio/charset/CoderResult.java b/src/share/classes/java/nio/charset/CoderResult.java index 00f29db07..5b2c4d41f 100644 --- a/src/share/classes/java/nio/charset/CoderResult.java +++ b/src/share/classes/java/nio/charset/CoderResult.java @@ -71,7 +71,7 @@ import java.util.HashMap; * * * - * For convenience, the {@link #isError() isError} method returns true + *

For convenience, the {@link #isError() isError} method returns true * for result objects that describe malformed-input and unmappable-character * errors but false for those that describe underflow or overflow * conditions.

@@ -112,7 +112,7 @@ public class CoderResult { } /** - * Tells whether or not this object describes an underflow condition.

+ * Tells whether or not this object describes an underflow condition. * * @return true 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.

+ * Tells whether or not this object describes an overflow condition. * * @return true 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.

+ * Tells whether or not this object describes an error condition. * * @return true 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. - *

* * @return true 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.

+ * error. * * @return true 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  (optional operation).

+ * object  (optional operation). * * @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.

+ * 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.

+ * 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.

+ * 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.

+ * 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. - *

* * @throws BufferUnderflowException * If this object is {@link #UNDERFLOW} diff --git a/src/share/classes/java/nio/charset/CodingErrorAction.java b/src/share/classes/java/nio/charset/CodingErrorAction.java index 8c9cb2193..8ca30e490 100644 --- a/src/share/classes/java/nio/charset/CodingErrorAction.java +++ b/src/share/classes/java/nio/charset/CodingErrorAction.java @@ -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.

+ * 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.

+ * 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.

+ * Returns a string describing this action. * * @return A descriptive string */ diff --git a/src/share/classes/java/nio/charset/UnmappableCharacterException.java b/src/share/classes/java/nio/charset/UnmappableCharacterException.java index 4af924fd1..5fa12476d 100644 --- a/src/share/classes/java/nio/charset/UnmappableCharacterException.java +++ b/src/share/classes/java/nio/charset/UnmappableCharacterException.java @@ -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.

+ * sequence. * * @since 1.4 */ diff --git a/src/share/classes/java/nio/charset/spi/CharsetProvider.java b/src/share/classes/java/nio/charset/spi/CharsetProvider.java index a4d646a86..3525e201d 100644 --- a/src/share/classes/java/nio/charset/spi/CharsetProvider.java +++ b/src/share/classes/java/nio/charset/spi/CharsetProvider.java @@ -72,7 +72,7 @@ import java.util.Iterator; public abstract class CharsetProvider { /** - * Initializes a new charset provider.

+ * 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.

+ * method. * * @return The new iterator */ public abstract Iterator charsets(); /** - * Retrieves a charset for the given charset name.

+ * Retrieves a charset for the given charset name. * * @param charsetName * The name of the requested charset; may be either -- GitLab