From 69b1fb5c35b1834acac862a56b90c79ca449c86d Mon Sep 17 00:00:00 2001 From: alanb Date: Mon, 10 Jun 2013 12:58:32 +0100 Subject: [PATCH] 8016217: More javadoc warnings Reviewed-by: lancea, chegar, psandoz --- .../classes/java/io/BufferedInputStream.java | 2 +- src/share/classes/java/io/BufferedReader.java | 4 +- src/share/classes/java/io/BufferedWriter.java | 2 +- src/share/classes/java/io/Console.java | 4 +- .../classes/java/io/PipedInputStream.java | 4 +- src/share/classes/java/io/PipedReader.java | 4 +- src/share/classes/java/io/PrintStream.java | 8 +- .../classes/java/io/PushbackInputStream.java | 2 +- src/share/classes/java/io/PushbackReader.java | 2 +- src/share/classes/java/io/StringReader.java | 2 +- src/share/classes/java/lang/Character.java | 4 +- src/share/classes/java/lang/ClassLoader.java | 2 +- src/share/classes/java/lang/Comparable.java | 2 +- src/share/classes/java/lang/Double.java | 10 +- src/share/classes/java/lang/Float.java | 10 +- .../classes/java/lang/StackTraceElement.java | 4 +- .../java/lang/instrument/Instrumentation.java | 20 +- .../java/lang/invoke/MethodHandle.java | 20 +- .../java/lang/invoke/MethodHandles.java | 4 +- .../java/lang/management/MemoryUsage.java | 4 +- .../java/lang/management/RuntimeMXBean.java | 2 +- .../java/lang/management/ThreadMXBean.java | 12 +- src/share/classes/java/net/CookieManager.java | 4 +- src/share/classes/java/net/CookiePolicy.java | 2 +- .../classes/java/net/DatagramSocket.java | 10 +- .../classes/java/net/HttpURLConnection.java | 4 +- .../classes/java/net/InetSocketAddress.java | 2 +- .../classes/java/net/MulticastSocket.java | 2 +- src/share/classes/java/net/ServerSocket.java | 6 +- src/share/classes/java/net/Socket.java | 6 +- .../java/net/StandardSocketOptions.java | 4 +- src/share/classes/java/net/URI.java | 2 +- src/share/classes/java/net/URLConnection.java | 4 +- .../classes/java/nio/X-Buffer.java.template | 28 +- .../java/nio/channels/SelectableChannel.java | 6 +- .../java/nio/channels/SelectionKey.java | 34 +- .../nio/charset/Charset-X-Coder.java.template | 4 +- src/share/classes/java/nio/file/Path.java | 4 +- src/share/classes/java/security/KeyStore.java | 2 +- .../classes/java/security/SecureRandom.java | 2 +- .../cert/CertPathValidatorException.java | 8 +- .../security/cert/CertificateFactory.java | 4 +- .../java/security/cert/X509Extension.java | 6 +- .../java/security/spec/EllipticCurve.java | 4 +- .../classes/java/sql/DatabaseMetaData.java | 514 +++++++++--------- src/share/classes/java/sql/DriverManager.java | 2 +- src/share/classes/java/sql/ResultSet.java | 2 +- src/share/classes/java/sql/Statement.java | 18 +- .../classes/java/text/CharacterIterator.java | 12 +- src/share/classes/java/text/ChoiceFormat.java | 2 +- src/share/classes/java/text/Collator.java | 4 +- src/share/classes/java/util/Calendar.java | 8 +- src/share/classes/java/util/Collections.java | 8 +- src/share/classes/java/util/Date.java | 7 +- .../classes/java/util/LinkedHashMap.java | 4 +- src/share/classes/java/util/Random.java | 2 +- .../classes/java/util/ResourceBundle.java | 4 +- src/share/classes/java/util/Scanner.java | 28 +- src/share/classes/java/util/TimerTask.java | 4 +- src/share/classes/java/util/jar/Pack200.java | 4 +- .../java/util/logging/ConsoleHandler.java | 2 +- .../java/util/logging/FileHandler.java | 4 +- .../java/util/logging/MemoryHandler.java | 4 +- .../classes/java/util/prefs/Preferences.java | 84 +-- .../classes/java/util/regex/MatchResult.java | 2 +- .../classes/java/util/regex/Pattern.java | 2 +- .../java/util/stream/package-info.java | 2 +- .../java/util/zip/DeflaterInputStream.java | 5 +- .../java/util/zip/DeflaterOutputStream.java | 4 +- .../java/util/zip/GZIPInputStream.java | 2 +- .../java/util/zip/GZIPOutputStream.java | 5 +- .../java/util/zip/InflaterInputStream.java | 4 +- .../java/util/zip/InflaterOutputStream.java | 6 +- .../classes/java/util/zip/ZipInputStream.java | 2 +- .../javax/crypto/spec/IvParameterSpec.java | 2 +- .../javax/crypto/spec/RC5ParameterSpec.java | 4 +- .../javax/crypto/spec/SecretKeySpec.java | 2 +- .../classes/javax/naming/BinaryRefAddr.java | 4 +- .../javax/naming/directory/Attribute.java | 8 +- .../classes/javax/naming/ldap/LdapName.java | 6 +- .../naming/ldap/PagedResultsControl.java | 8 +- .../javax/naming/ldap/SortControl.java | 4 +- .../classes/javax/net/ssl/SNIHostName.java | 4 +- .../classes/javax/net/ssl/SSLEngine.java | 12 +- .../javax/net/ssl/SSLEngineResult.java | 2 +- .../javax/net/ssl/SSLSessionContext.java | 4 +- .../javax/script/ScriptEngineFactory.java | 14 +- .../auth/callback/CallbackHandler.java | 4 +- .../classes/javax/security/sasl/Sasl.java | 8 +- .../javax/security/sasl/SaslClient.java | 8 +- .../javax/security/sasl/SaslServer.java | 4 +- .../javax/smartcardio/ResponseAPDU.java | 2 +- src/share/classes/javax/sql/DataSource.java | 4 +- .../classes/javax/sql/rowset/BaseRowSet.java | 16 +- .../javax/sql/rowset/CachedRowSet.java | 24 +- .../classes/javax/sql/rowset/Predicate.java | 21 +- .../javax/sql/rowset/RowSetMetaDataImpl.java | 8 +- .../javax/sql/rowset/spi/SyncFactory.java | 2 - .../javax/sql/rowset/spi/SyncResolver.java | 8 +- .../javax/xml/crypto/dsig/Manifest.java | 18 +- 100 files changed, 617 insertions(+), 611 deletions(-) diff --git a/src/share/classes/java/io/BufferedInputStream.java b/src/share/classes/java/io/BufferedInputStream.java index fcc7e702d..a161a9881 100644 --- a/src/share/classes/java/io/BufferedInputStream.java +++ b/src/share/classes/java/io/BufferedInputStream.java @@ -185,7 +185,7 @@ class BufferedInputStream extends FilterInputStream { * * @param in the underlying input stream. * @param size the buffer size. - * @exception IllegalArgumentException if size <= 0. + * @exception IllegalArgumentException if {@code size <= 0}. */ public BufferedInputStream(InputStream in, int size) { super(in); diff --git a/src/share/classes/java/io/BufferedReader.java b/src/share/classes/java/io/BufferedReader.java index d742233a0..ebf398078 100644 --- a/src/share/classes/java/io/BufferedReader.java +++ b/src/share/classes/java/io/BufferedReader.java @@ -95,7 +95,7 @@ public class BufferedReader extends Reader { * @param in A Reader * @param sz Input-buffer size * - * @exception IllegalArgumentException If sz is <= 0 + * @exception IllegalArgumentException If {@code sz <= 0} */ public BufferedReader(Reader in, int sz) { super(in); @@ -484,7 +484,7 @@ public class BufferedReader extends Reader { * whose size is no smaller than limit. * Therefore large values should be used with care. * - * @exception IllegalArgumentException If readAheadLimit is < 0 + * @exception IllegalArgumentException If {@code readAheadLimit < 0} * @exception IOException If an I/O error occurs */ public void mark(int readAheadLimit) throws IOException { diff --git a/src/share/classes/java/io/BufferedWriter.java b/src/share/classes/java/io/BufferedWriter.java index 83a467e72..01dfb175e 100644 --- a/src/share/classes/java/io/BufferedWriter.java +++ b/src/share/classes/java/io/BufferedWriter.java @@ -95,7 +95,7 @@ public class BufferedWriter extends Writer { * @param out A Writer * @param sz Output-buffer size, a positive integer * - * @exception IllegalArgumentException If sz is <= 0 + * @exception IllegalArgumentException If {@code sz <= 0} */ public BufferedWriter(Writer out, int sz) { super(out); diff --git a/src/share/classes/java/io/Console.java b/src/share/classes/java/io/Console.java index c4987dc09..c100f8a0c 100644 --- a/src/share/classes/java/io/Console.java +++ b/src/share/classes/java/io/Console.java @@ -75,7 +75,7 @@ import sun.nio.cs.StreamEncoder; * manually zero the returned character array after processing to minimize the * lifetime of sensitive data in memory. * - *
+ * 
{@code
  * Console cons;
  * char[] passwd;
  * if ((cons = System.console()) != null &&
@@ -83,7 +83,7 @@ import sun.nio.cs.StreamEncoder;
  *     ...
  *     java.util.Arrays.fill(passwd, ' ');
  * }
- * 
+ * }
* * @author Xueming Shen * @since 1.6 diff --git a/src/share/classes/java/io/PipedInputStream.java b/src/share/classes/java/io/PipedInputStream.java index ca2115430..4ad8fbd81 100644 --- a/src/share/classes/java/io/PipedInputStream.java +++ b/src/share/classes/java/io/PipedInputStream.java @@ -117,7 +117,7 @@ public class PipedInputStream extends InputStream { * @param src the stream to connect to. * @param pipeSize the size of the pipe's buffer. * @exception IOException if an I/O error occurs. - * @exception IllegalArgumentException if pipeSize <= 0. + * @exception IllegalArgumentException if {@code pipeSize <= 0}. * @since 1.6 */ public PipedInputStream(PipedOutputStream src, int pipeSize) @@ -147,7 +147,7 @@ public class PipedInputStream extends InputStream { * connected} to a PipedOutputStream before being used. * * @param pipeSize the size of the pipe's buffer. - * @exception IllegalArgumentException if pipeSize <= 0. + * @exception IllegalArgumentException if {@code pipeSize <= 0}. * @since 1.6 */ public PipedInputStream(int pipeSize) { diff --git a/src/share/classes/java/io/PipedReader.java b/src/share/classes/java/io/PipedReader.java index 95cfe1d7b..bb86022af 100644 --- a/src/share/classes/java/io/PipedReader.java +++ b/src/share/classes/java/io/PipedReader.java @@ -91,7 +91,7 @@ public class PipedReader extends Reader { * @param src the stream to connect to. * @param pipeSize the size of the pipe's buffer. * @exception IOException if an I/O error occurs. - * @exception IllegalArgumentException if pipeSize <= 0. + * @exception IllegalArgumentException if {@code pipeSize <= 0}. * @since 1.6 */ public PipedReader(PipedWriter src, int pipeSize) throws IOException { @@ -120,7 +120,7 @@ public class PipedReader extends Reader { * before being used. * * @param pipeSize the size of the pipe's buffer. - * @exception IllegalArgumentException if pipeSize <= 0. + * @exception IllegalArgumentException if {@code pipeSize <= 0}. * @since 1.6 */ public PipedReader(int pipeSize) { diff --git a/src/share/classes/java/io/PrintStream.java b/src/share/classes/java/io/PrintStream.java index c4cd01f47..b803c6a65 100644 --- a/src/share/classes/java/io/PrintStream.java +++ b/src/share/classes/java/io/PrintStream.java @@ -851,7 +851,7 @@ public class PrintStream extends FilterOutputStream * null argument depends on the conversion. * - * @throws IllegalFormatException + * @throws java.util.IllegalFormatException * If a format string contains an illegal syntax, a format * specifier that is incompatible with the given arguments, * insufficient arguments given the format string, or other @@ -901,7 +901,7 @@ public class PrintStream extends FilterOutputStream * null argument depends on the conversion. * - * @throws IllegalFormatException + * @throws java.util.IllegalFormatException * If a format string contains an illegal syntax, a format * specifier that is incompatible with the given arguments, * insufficient arguments given the format string, or other @@ -944,7 +944,7 @@ public class PrintStream extends FilterOutputStream * null argument depends on the conversion. * - * @throws IllegalFormatException + * @throws java.util.IllegalFormatException * If a format string contains an illegal syntax, a format * specifier that is incompatible with the given arguments, * insufficient arguments given the format string, or other @@ -1001,7 +1001,7 @@ public class PrintStream extends FilterOutputStream * null argument depends on the conversion. * - * @throws IllegalFormatException + * @throws java.util.IllegalFormatException * If a format string contains an illegal syntax, a format * specifier that is incompatible with the given arguments, * insufficient arguments given the format string, or other diff --git a/src/share/classes/java/io/PushbackInputStream.java b/src/share/classes/java/io/PushbackInputStream.java index af0b525a6..b81bec424 100644 --- a/src/share/classes/java/io/PushbackInputStream.java +++ b/src/share/classes/java/io/PushbackInputStream.java @@ -85,7 +85,7 @@ class PushbackInputStream extends FilterInputStream { * * @param in the input stream from which bytes will be read. * @param size the size of the pushback buffer. - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} * @since JDK1.1 */ public PushbackInputStream(InputStream in, int size) { diff --git a/src/share/classes/java/io/PushbackReader.java b/src/share/classes/java/io/PushbackReader.java index 2f5b18cfe..98ebd5dab 100644 --- a/src/share/classes/java/io/PushbackReader.java +++ b/src/share/classes/java/io/PushbackReader.java @@ -47,7 +47,7 @@ public class PushbackReader extends FilterReader { * * @param in The reader from which characters will be read * @param size The size of the pushback buffer - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} */ public PushbackReader(Reader in, int size) { super(in); diff --git a/src/share/classes/java/io/StringReader.java b/src/share/classes/java/io/StringReader.java index 3778408e5..0cdf8fd21 100644 --- a/src/share/classes/java/io/StringReader.java +++ b/src/share/classes/java/io/StringReader.java @@ -163,7 +163,7 @@ public class StringReader extends Reader { * is no actual limit, so this argument must not * be negative, but is otherwise ignored. * - * @exception IllegalArgumentException If readAheadLimit is < 0 + * @exception IllegalArgumentException If {@code readAheadLimit < 0} * @exception IOException If an I/O error occurs */ public void mark(int readAheadLimit) throws IOException { diff --git a/src/share/classes/java/lang/Character.java b/src/share/classes/java/lang/Character.java index 531263d38..e512e5826 100644 --- a/src/share/classes/java/lang/Character.java +++ b/src/share/classes/java/lang/Character.java @@ -4782,9 +4782,9 @@ class Character implements java.io.Serializable, Comparable { * Unicode surrogate pair. *

This method is equivalent to the expression: - *

+     * 
{@code
      * isHighSurrogate(high) && isLowSurrogate(low)
-     * 
+ * }
* * @param high the high-surrogate code value to be tested * @param low the low-surrogate code value to be tested diff --git a/src/share/classes/java/lang/ClassLoader.java b/src/share/classes/java/lang/ClassLoader.java index 8d0205f54..f26eafd98 100644 --- a/src/share/classes/java/lang/ClassLoader.java +++ b/src/share/classes/java/lang/ClassLoader.java @@ -702,7 +702,7 @@ public abstract class ClassLoader { * bootstrap class loader. If name is not null, it * must be equal to the binary name of the class * specified by the byte array "b", otherwise a {@link - * NoClassDefFoundError} will be thrown.

+ * NoClassDefFoundError NoClassDefFoundError} will be thrown.

* * @param name * The expected binary name of the class, or diff --git a/src/share/classes/java/lang/Comparable.java b/src/share/classes/java/lang/Comparable.java index 123e10aa4..9d607679a 100644 --- a/src/share/classes/java/lang/Comparable.java +++ b/src/share/classes/java/lang/Comparable.java @@ -56,7 +56,7 @@ import java.util.*; * method.

* * For example, if one adds two keys a and b such that - * (!a.equals(b) && a.compareTo(b) == 0) to a sorted + * {@code (!a.equals(b) && a.compareTo(b) == 0)} to a sorted * set that does not use an explicit comparator, the second add * operation returns false (and the size of the sorted set does not increase) * because a and b are equivalent from the sorted set's diff --git a/src/share/classes/java/lang/Double.java b/src/share/classes/java/lang/Double.java index a32d04cf7..3f0e2cddd 100644 --- a/src/share/classes/java/lang/Double.java +++ b/src/share/classes/java/lang/Double.java @@ -917,13 +917,13 @@ public final class Double extends Number implements Comparable { *

In all other cases, let s, e, and m be three * values that can be computed from the argument: * - *

-     * int s = ((bits >> 63) == 0) ? 1 : -1;
-     * int e = (int)((bits >> 52) & 0x7ffL);
+     * 
{@code
+     * int s = ((bits >> 63) == 0) ? 1 : -1;
+     * int e = (int)((bits >> 52) & 0x7ffL);
      * long m = (e == 0) ?
-     *                 (bits & 0xfffffffffffffL) << 1 :
+     *                 (bits & 0xfffffffffffffL) << 1 :
      *                 (bits & 0xfffffffffffffL) | 0x10000000000000L;
-     * 
+ * }
* * Then the floating-point result equals the value of the mathematical * expression s·m·2e-1075. diff --git a/src/share/classes/java/lang/Float.java b/src/share/classes/java/lang/Float.java index 5b077111f..e46dff02a 100644 --- a/src/share/classes/java/lang/Float.java +++ b/src/share/classes/java/lang/Float.java @@ -821,13 +821,13 @@ public final class Float extends Number implements Comparable { *

In all other cases, let s, e, and m be three * values that can be computed from the argument: * - *

-     * int s = ((bits >> 31) == 0) ? 1 : -1;
-     * int e = ((bits >> 23) & 0xff);
+     * 
{@code
+     * int s = ((bits >> 31) == 0) ? 1 : -1;
+     * int e = ((bits >> 23) & 0xff);
      * int m = (e == 0) ?
-     *                 (bits & 0x7fffff) << 1 :
+     *                 (bits & 0x7fffff) << 1 :
      *                 (bits & 0x7fffff) | 0x800000;
-     * 
+ * }
* * Then the floating-point result equals the value of the mathematical * expression s·m·2e-150. diff --git a/src/share/classes/java/lang/StackTraceElement.java b/src/share/classes/java/lang/StackTraceElement.java index b973d0f42..4543749bb 100644 --- a/src/share/classes/java/lang/StackTraceElement.java +++ b/src/share/classes/java/lang/StackTraceElement.java @@ -181,12 +181,12 @@ public final class StackTraceElement implements java.io.Serializable { * {@code StackTraceElement} instance representing the same execution * point as this instance. Two stack trace elements {@code a} and * {@code b} are equal if and only if: - *
+     * 
{@code
      *     equals(a.getFileName(), b.getFileName()) &&
      *     a.getLineNumber() == b.getLineNumber()) &&
      *     equals(a.getClassName(), b.getClassName()) &&
      *     equals(a.getMethodName(), b.getMethodName())
-     * 
+ * }
* where {@code equals} has the semantics of {@link * java.util.Objects#equals(Object, Object) Objects.equals}. * diff --git a/src/share/classes/java/lang/instrument/Instrumentation.java b/src/share/classes/java/lang/instrument/Instrumentation.java index 3d2083d6c..1844837fd 100644 --- a/src/share/classes/java/lang/instrument/Instrumentation.java +++ b/src/share/classes/java/lang/instrument/Instrumentation.java @@ -593,24 +593,28 @@ public interface Instrumentation { * and the normal automatic resolution. For * RegisterNatives, the JVM will attempt this * association: - *
-     *   method(foo) -> nativeImplementation(foo)
+ *
{@code
+     *   method(foo) -> nativeImplementation(foo)
+     * }
*

* When this fails, the resolution will be retried with * the specified prefix prepended to the method name, * yielding the correct resolution: - *

-     *   method(wrapped_foo) -> nativeImplementation(foo)
+ *
{@code
+     *   method(wrapped_foo) -> nativeImplementation(foo)
+     * }
*

* For automatic resolution, the JVM will attempt: - *

-     *   method(wrapped_foo) -> nativeImplementation(wrapped_foo)
+ *
{@code
+     *   method(wrapped_foo) -> nativeImplementation(wrapped_foo)
+     * }
*

* When this fails, the resolution will be retried with * the specified prefix deleted from the implementation name, * yielding the correct resolution: - *

-     *   method(wrapped_foo) -> nativeImplementation(foo)
+ *
{@code
+     *   method(wrapped_foo) -> nativeImplementation(foo)
+     * }
*

* Note that since the prefix is only used when standard * resolution fails, native methods can be wrapped selectively. diff --git a/src/share/classes/java/lang/invoke/MethodHandle.java b/src/share/classes/java/lang/invoke/MethodHandle.java index 774faff5a..06084056f 100644 --- a/src/share/classes/java/lang/invoke/MethodHandle.java +++ b/src/share/classes/java/lang/invoke/MethodHandle.java @@ -251,7 +251,7 @@ import java.util.logging.Logger; * *

Usage examples

* Here are some examples of usage: - *

+ * 

{@code
 Object x, y; String s; int i;
 MethodType mt; MethodHandle mh;
 MethodHandles.Lookup lookup = MethodHandles.lookup();
@@ -287,7 +287,7 @@ mt = MethodType.methodType(void.class, String.class);
 mh = lookup.findVirtual(java.io.PrintStream.class, "println", mt);
 mh.invokeExact(System.out, "Hello, world.");
 // invokeExact(Ljava/io/PrintStream;Ljava/lang/String;)V
- * 
+ * }
* Each of the above calls to {@code invokeExact} or plain {@code invoke} * generates a single invokevirtual instruction with * the symbolic type descriptor indicated in the following comment. @@ -754,7 +754,7 @@ public abstract class MethodHandle { * (The array may also be null when zero elements are required.) *

* Here are some simple examples of array-spreading method handles: - *

+     * 
{@code
 MethodHandle equals = publicLookup()
   .findVirtual(String.class, "equals", methodType(boolean.class, Object.class));
 assert( (boolean) equals.invokeExact("me", (Object)"me"));
@@ -790,7 +790,7 @@ MethodHandle caString3 = caToString.asCollector(char[].class, 3);
 assertEquals("[A, B, C]", (String) caString3.invokeExact('A', 'B', 'C'));
 MethodHandle caToString2 = caString3.asSpreader(char[].class, 2);
 assertEquals("[A, B, C]", (String) caToString2.invokeExact('A', "BC".toCharArray()));
-     * 
+ * }
* @param arrayType usually {@code Object[]}, the type of the array argument from which to extract the spread arguments * @param arrayLength the number of arguments to spread from an incoming array argument * @return a new method handle which spreads its final array argument, @@ -878,7 +878,7 @@ assertEquals("[A, B, C]", (String) caToString2.invokeExact('A', "BC".toCharArray * number of collected arguments, use {@link #asVarargsCollector asVarargsCollector} instead. *

* Here are some examples of array-collecting method handles: - *

+     * 
{@code
 MethodHandle deepToString = publicLookup()
   .findStatic(Arrays.class, "deepToString", methodType(String.class, Object[].class));
 assertEquals("[won]",   (String) deepToString.invokeExact(new Object[]{"won"}));
@@ -904,7 +904,7 @@ MethodHandle longsToString = publicLookup()
   .findStatic(Arrays.class, "toString", methodType(String.class, long[].class))
   .asCollector(long[].class, 1);
 assertEquals("[123]", (String) longsToString.invokeExact((long)123));
-     * 
+ * }
* @param arrayType often {@code Object[]}, the type of the array argument which will collect the arguments * @param arrayLength the number of arguments to collect into a new array argument * @return a new method handle which collects some trailing argument @@ -1041,7 +1041,7 @@ assertEquals("[123]", (String) longsToString.invokeExact((long)123)); * It may (or may not) return the original variable arity method handle. *

* Here is an example, of a list-making variable arity method handle: - *

+     * 
{@code
 MethodHandle deepToString = publicLookup()
   .findStatic(Arrays.class, "deepToString", methodType(String.class, Object[].class));
 MethodHandle ts1 = deepToString.asVarargsCollector(Object[].class);
@@ -1063,7 +1063,7 @@ assertEquals("[three, thee, tee]", asList.invoke((Object[])argv).toString());
 List ls = (List) asList.invoke((Object)argv);
 assertEquals(1, ls.size());
 assertEquals("[three, thee, tee]", Arrays.toString((Object[])ls.get(0)));
-     * 
+ * }
*

* Discussion: * These rules are designed as a dynamically-typed variation @@ -1134,7 +1134,7 @@ assertEquals("[three, thee, tee]", Arrays.toString((Object[])ls.get(0))); * a previous argument to {@code asVarargsCollector}. *

* Here is an example, of a list-making variable arity method handle: - *

+     * 
{@code
 MethodHandle asListVar = publicLookup()
   .findStatic(Arrays.class, "asList", methodType(List.class, Object[].class))
   .asVarargsCollector(Object[].class);
@@ -1153,7 +1153,7 @@ assertEquals("[three, thee, tee]", asListVar.invoke(argv).toString());
 assertEquals("[three, thee, tee]", asListFix.invoke(argv).toString());
 assertEquals(1, ((List) asListVar.invoke((Object)argv)).size());
 assertEquals("[three, thee, tee]", asListFix.invoke((Object)argv).toString());
-     * 
+ * }
* * @return a new method handle which accepts only a fixed number of arguments * @see #asVarargsCollector diff --git a/src/share/classes/java/lang/invoke/MethodHandles.java b/src/share/classes/java/lang/invoke/MethodHandles.java index fa3cb6078..9c54f3cf7 100644 --- a/src/share/classes/java/lang/invoke/MethodHandles.java +++ b/src/share/classes/java/lang/invoke/MethodHandles.java @@ -1593,7 +1593,7 @@ publicLookup().findVirtual(MethodHandle.class, "invoke", type) * As in the case of {@link #dropArguments(MethodHandle,int,List) dropArguments}, * incoming arguments which are not mentioned in the reordering array * are may be any type, as determined only by {@code newType}. - *
+     * 
{@code
 import static java.lang.invoke.MethodHandles.*;
 import static java.lang.invoke.MethodType.*;
 ...
@@ -1609,7 +1609,7 @@ assert(add.type().equals(intfn2));
 MethodHandle twice = permuteArguments(add, intfn1, 0, 0);
 assert(twice.type().equals(intfn1));
 assert((int)twice.invokeExact(21) == 42);
-     * 
+ * }
* @param target the method handle to invoke after arguments are reordered * @param newType the expected type of the new method handle * @param reorder an index array which controls the reordering diff --git a/src/share/classes/java/lang/management/MemoryUsage.java b/src/share/classes/java/lang/management/MemoryUsage.java index c223c7107..4dc23c0fe 100644 --- a/src/share/classes/java/lang/management/MemoryUsage.java +++ b/src/share/classes/java/lang/management/MemoryUsage.java @@ -72,8 +72,8 @@ import sun.management.MemoryUsageCompositeData; * The amount of used and committed memory will always be less than * or equal to max if max is defined. * A memory allocation may fail if it attempts to increase the - * used memory such that used > committed even - * if used <= max would still be true (for example, + * used memory such that used > committed even + * if used <= max would still be true (for example, * when the system is low on virtual memory). * * diff --git a/src/share/classes/java/lang/management/RuntimeMXBean.java b/src/share/classes/java/lang/management/RuntimeMXBean.java index 62463af44..e4142d3e4 100644 --- a/src/share/classes/java/lang/management/RuntimeMXBean.java +++ b/src/share/classes/java/lang/management/RuntimeMXBean.java @@ -308,7 +308,7 @@ public interface RuntimeMXBean extends PlatformManagedObject { * *

* MBeanServer access:
- * The mapped type of Map is + * The mapped type of {@code Map} is * {@link javax.management.openmbean.TabularData TabularData} * with two items in each row as follows: *

diff --git a/src/share/classes/java/lang/management/ThreadMXBean.java b/src/share/classes/java/lang/management/ThreadMXBean.java index f804af194..30251d51f 100644 --- a/src/share/classes/java/lang/management/ThreadMXBean.java +++ b/src/share/classes/java/lang/management/ThreadMXBean.java @@ -198,7 +198,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * null if the thread of the given ID is not alive or * it does not exist. * - * @throws IllegalArgumentException if id <= 0. + * @throws IllegalArgumentException if {@code id <= 0}. * @throws java.lang.SecurityException if a security manager * exists and the caller does not have * ManagementPermission("monitor"). @@ -236,7 +236,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * with no stack trace, no locked monitor and no synchronizer info. * * @throws IllegalArgumentException if any element in the input array - * ids is <= 0. + * ids is {@code <= 0}. * @throws java.lang.SecurityException if a security manager * exists and the caller does not have * ManagementPermission("monitor"). @@ -282,7 +282,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * null if the thread of the given ID is not alive or * it does not exist. * - * @throws IllegalArgumentException if id <= 0. + * @throws IllegalArgumentException if {@code id <= 0}. * @throws IllegalArgumentException if maxDepth is negative. * @throws java.lang.SecurityException if a security manager * exists and the caller does not have @@ -336,7 +336,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * * @throws IllegalArgumentException if maxDepth is negative. * @throws IllegalArgumentException if any element in the input array - * ids is <= 0. + * ids is {@code <= 0}. * @throws java.lang.SecurityException if a security manager * exists and the caller does not have * ManagementPermission("monitor"). @@ -466,7 +466,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * and CPU time measurement is enabled; * -1 otherwise. * - * @throws IllegalArgumentException if id <= 0 . + * @throws IllegalArgumentException if {@code id <= 0}. * @throws java.lang.UnsupportedOperationException if the Java * virtual machine does not support CPU time measurement for * other threads. @@ -501,7 +501,7 @@ public interface ThreadMXBean extends PlatformManagedObject { * and CPU time measurement is enabled; * -1 otherwise. * - * @throws IllegalArgumentException if id <= 0 . + * @throws IllegalArgumentException if {@code id <= 0}. * @throws java.lang.UnsupportedOperationException if the Java * virtual machine does not support CPU time measurement for * other threads. diff --git a/src/share/classes/java/net/CookieManager.java b/src/share/classes/java/net/CookieManager.java index 90c7262b4..fde828f95 100644 --- a/src/share/classes/java/net/CookieManager.java +++ b/src/share/classes/java/net/CookieManager.java @@ -41,7 +41,7 @@ import sun.util.logging.PlatformLogger; * *

The HTTP cookie management in java.net package looks like: *

- *
+ * 
{@code
  *                  use
  * CookieHandler <------- HttpURLConnection
  *       ^
@@ -58,7 +58,7 @@ import sun.util.logging.PlatformLogger;
  *                            | impl
  *                            |
  *                  Internal in-memory implementation
- * 
+ * }
*
    *
  • * CookieHandler is at the core of cookie management. User can call diff --git a/src/share/classes/java/net/CookiePolicy.java b/src/share/classes/java/net/CookiePolicy.java index aae5c1a80..3de98f904 100644 --- a/src/share/classes/java/net/CookiePolicy.java +++ b/src/share/classes/java/net/CookiePolicy.java @@ -30,7 +30,7 @@ package java.net; * and which should be rejected. Three pre-defined policy implementations * are provided, namely ACCEPT_ALL, ACCEPT_NONE and ACCEPT_ORIGINAL_SERVER. * - *

    See RFC 2965 sec. 3.3 & 7 for more detail. + *

    See RFC 2965 sec. 3.3 and 7 for more detail. * * @author Edward Wang * @since 1.6 diff --git a/src/share/classes/java/net/DatagramSocket.java b/src/share/classes/java/net/DatagramSocket.java index ad0af4850..d6ffca237 100644 --- a/src/share/classes/java/net/DatagramSocket.java +++ b/src/share/classes/java/net/DatagramSocket.java @@ -334,12 +334,12 @@ class DatagramSocket implements java.io.Closeable { } /** - * Binds this DatagramSocket to a specific address & port. + * Binds this DatagramSocket to a specific address and port. *

    * If the address is null, then the system will pick up * an ephemeral port and a valid local address to bind the socket. *

    - * @param addr The address & port to bind to. + * @param addr The address and port to bind to. * @throws SocketException if any error happens during the bind, or if the * socket is already bound. * @throws SecurityException if a security manager exists and its @@ -844,7 +844,7 @@ class DatagramSocket implements java.io.Closeable { * a java.net.SocketTimeoutException is raised, though the * DatagramSocket is still valid. The option must be enabled * prior to entering the blocking operation to have effect. The - * timeout must be > 0. + * timeout must be {@code > 0}. * A timeout of zero is interpreted as an infinite timeout. * * @param timeout the specified timeout in milliseconds. @@ -1101,8 +1101,8 @@ class DatagramSocket implements java.io.Closeable { * As the underlying network implementation may ignore this * value applications should consider it a hint. * - *

    The tc must be in the range 0 <= tc <= - * 255 or an IllegalArgumentException will be thrown. + *

    The tc must be in the range {@code 0 <= tc <= + * 255} or an IllegalArgumentException will be thrown. *

    Notes: *

    For Internet Protocol v4 the value consists of an * integer, the least significant 8 bits of which diff --git a/src/share/classes/java/net/HttpURLConnection.java b/src/share/classes/java/net/HttpURLConnection.java index 193b9cef1..b93f1e731 100644 --- a/src/share/classes/java/net/HttpURLConnection.java +++ b/src/share/classes/java/net/HttpURLConnection.java @@ -109,7 +109,7 @@ abstract public class HttpURLConnection extends URLConnection { * server. In this case, {@link #getHeaderField(int) getHeaderField(0)} returns the status * line, but getHeaderFieldKey(0) returns null. * - * @param n an index, where n >=0. + * @param n an index, where {@code n >=0}. * @return the key for the nth header field, * or null if the key does not exist. */ @@ -260,7 +260,7 @@ abstract public class HttpURLConnection extends URLConnection { * {@link #getHeaderFieldKey getHeaderFieldKey} method to iterate through all * the headers in the message. * - * @param n an index, where n>=0. + * @param n an index, where {@code n>=0}. * @return the value of the nth header field, * or null if the value does not exist. * @see java.net.HttpURLConnection#getHeaderFieldKey(int) diff --git a/src/share/classes/java/net/InetSocketAddress.java b/src/share/classes/java/net/InetSocketAddress.java index 4ad950434..44604c664 100644 --- a/src/share/classes/java/net/InetSocketAddress.java +++ b/src/share/classes/java/net/InetSocketAddress.java @@ -389,7 +389,7 @@ public class InetSocketAddress * Two instances of InetSocketAddress represent the same * address if both the InetAddresses (or hostnames if it is unresolved) and port * numbers are equal. - * If both addresses are unresolved, then the hostname & the port number + * If both addresses are unresolved, then the hostname and the port number * are compared. * * Note: Hostnames are case insensitive. e.g. "FooBar" and "foobar" are diff --git a/src/share/classes/java/net/MulticastSocket.java b/src/share/classes/java/net/MulticastSocket.java index ad4c7566a..0a4d7c102 100644 --- a/src/share/classes/java/net/MulticastSocket.java +++ b/src/share/classes/java/net/MulticastSocket.java @@ -201,7 +201,7 @@ class MulticastSocket extends DatagramSocket { * scope of the multicasts. * *

    The ttl is an unsigned 8-bit quantity, and so must be - * in the range 0 <= ttl <= 0xFF . + * in the range {@code 0 <= ttl <= 0xFF }. * * @param ttl the time-to-live * @exception IOException if an I/O exception occurs diff --git a/src/share/classes/java/net/ServerSocket.java b/src/share/classes/java/net/ServerSocket.java index b47e4420e..52600bff6 100644 --- a/src/share/classes/java/net/ServerSocket.java +++ b/src/share/classes/java/net/ServerSocket.java @@ -316,7 +316,7 @@ class ServerSocket implements java.io.Closeable { * If the address is null, then the system will pick up * an ephemeral port and a valid local address to bind the socket. *

    - * @param endpoint The IP address & port number to bind to. + * @param endpoint The IP address and port number to bind to. * @throws IOException if the bind operation fails, or if the socket * is already bound. * @throws SecurityException if a SecurityManager is present and @@ -343,7 +343,7 @@ class ServerSocket implements java.io.Closeable { * or may choose to ignore the parameter altogther. The value provided * should be greater than 0. If it is less than or equal to * 0, then an implementation specific default will be used. - * @param endpoint The IP address & port number to bind to. + * @param endpoint The IP address and port number to bind to. * @param backlog requested maximum length of the queue of * incoming connections. * @throws IOException if the bind operation fails, or if the socket @@ -614,7 +614,7 @@ class ServerSocket implements java.io.Closeable { * a java.net.SocketTimeoutException is raised, though the * ServerSocket is still valid. The option must be enabled * prior to entering the blocking operation to have effect. The - * timeout must be > 0. + * timeout must be {@code > 0}. * A timeout of zero is interpreted as an infinite timeout. * @param timeout the specified timeout, in milliseconds * @exception SocketException if there is an error in diff --git a/src/share/classes/java/net/Socket.java b/src/share/classes/java/net/Socket.java index e0635c1bf..08b7ae616 100644 --- a/src/share/classes/java/net/Socket.java +++ b/src/share/classes/java/net/Socket.java @@ -1086,7 +1086,7 @@ class Socket implements java.io.Closeable { * expires, a java.net.SocketTimeoutException is raised, though the * Socket is still valid. The option must be enabled * prior to entering the blocking operation to have effect. The - * timeout must be > 0. + * timeout must be {@code > 0}. * A timeout of zero is interpreted as an infinite timeout. * * @param timeout the specified timeout, in milliseconds. @@ -1295,8 +1295,8 @@ class Socket implements java.io.Closeable { * As the underlying network implementation may ignore this * value applications should consider it a hint. * - *

    The tc must be in the range 0 <= tc <= - * 255 or an IllegalArgumentException will be thrown. + *

    The tc must be in the range {@code 0 <= tc <= + * 255} or an IllegalArgumentException will be thrown. *

    Notes: *

    For Internet Protocol v4 the value consists of an * integer, the least significant 8 bits of which diff --git a/src/share/classes/java/net/StandardSocketOptions.java b/src/share/classes/java/net/StandardSocketOptions.java index 9aeed2b5a..84fedd804 100644 --- a/src/share/classes/java/net/StandardSocketOptions.java +++ b/src/share/classes/java/net/StandardSocketOptions.java @@ -277,8 +277,8 @@ public final class StandardSocketOptions { * The time-to-live for Internet Protocol (IP) multicast datagrams. * *

    The value of this socket option is an {@code Integer} in the range - * 0 <= value <= 255. It is used to control - * the scope of multicast datagrams sent by the datagram-oriented socket. + * {@code 0 <= value <= 255}. It is used to control the scope of multicast + * datagrams sent by the datagram-oriented socket. * In the case of an {@link StandardProtocolFamily#INET IPv4} socket * the option is the time-to-live (TTL) on multicast datagrams sent by the * socket. Datagrams with a TTL of zero are not transmitted on the network diff --git a/src/share/classes/java/net/URI.java b/src/share/classes/java/net/URI.java index b4b22ded1..ed90f090c 100644 --- a/src/share/classes/java/net/URI.java +++ b/src/share/classes/java/net/URI.java @@ -258,7 +258,7 @@ import java.lang.NullPointerException; // for javadoc * All alphanum characters together with those in the string * "_-!.~'()*" * punct - * The characters in the string ",;:$&+=" + * The characters in the string ",;:$&+=" * reserved * All punct characters together with those in the string * "?/[]@" diff --git a/src/share/classes/java/net/URLConnection.java b/src/share/classes/java/net/URLConnection.java index f1c518807..b69c00f94 100644 --- a/src/share/classes/java/net/URLConnection.java +++ b/src/share/classes/java/net/URLConnection.java @@ -662,7 +662,7 @@ public abstract class URLConnection { * Returns the key for the nth header field. * It returns null if there are fewer than n+1 fields. * - * @param n an index, where n>=0 + * @param n an index, where {@code n>=0} * @return the key for the nth header field, * or null if there are fewer than n+1 * fields. @@ -680,7 +680,7 @@ public abstract class URLConnection { * {@link #getHeaderFieldKey(int) getHeaderFieldKey} method to iterate through all * the headers in the message. * - * @param n an index, where n>=0 + * @param n an index, where {@code n>=0} * @return the value of the nth header field * or null if there are fewer than n+1 fields * @see java.net.URLConnection#getHeaderFieldKey(int) diff --git a/src/share/classes/java/nio/X-Buffer.java.template b/src/share/classes/java/nio/X-Buffer.java.template index 475818d30..738b18b51 100644 --- a/src/share/classes/java/nio/X-Buffer.java.template +++ b/src/share/classes/java/nio/X-Buffer.java.template @@ -652,9 +652,10 @@ public abstract class $Type$Buffer * src.get(dst, off, len) has exactly the same effect as * the loop * - *

    +     * 
    {@code
          *     for (int i = off; i < off + len; i++)
    -     *         dst[i] = src.get(); 
    + * dst[i] = src.get(): + * }
    * * except that it first checks that there are sufficient $type$s in * this buffer and it is potentially much more efficient.

    @@ -788,9 +789,10 @@ public abstract class $Type$Buffer * dst.put(src, off, len) has exactly the same effect as * the loop * - *
    +     * 
    {@code
          *     for (int i = off; i < off + len; i++)
    -     *         dst.put(a[i]); 
    + * dst.put(a[i]); + * }
    * * except that it first checks that there is sufficient space in this * buffer and it is potentially much more efficient.

    @@ -874,9 +876,10 @@ public abstract class $Type$Buffer * dst.put(src, start, end) has exactly the same effect * as the loop * - *
    +     * 
    {@code
          *     for (int i = start; i < end; i++)
    -     *         dst.put(src.charAt(i)); 
    + * dst.put(src.charAt(i)); + * }
    * * except that it first checks that there is sufficient space in this * buffer and it is potentially much more efficient.

    @@ -1038,12 +1041,13 @@ public abstract class $Type$Buffer * write was incomplete. The following loop, for example, copies bytes * from one channel to another via the buffer buf: * - *
    -     * buf.clear();          // Prepare buffer for use
    -     * while (in.read(buf) >= 0 || buf.position != 0) {
    -     *     buf.flip();
    -     *     out.write(buf);
    -     *     buf.compact();    // In case of partial write
    +     * 
    {@code
    +     *   buf.clear();          // Prepare buffer for use
    +     *   while (in.read(buf) >= 0 || buf.position != 0) {
    +     *       buf.flip();
    +     *       out.write(buf);
    +     *       buf.compact();    // In case of partial write
    +     *   }
          * }
    * #end[byte] diff --git a/src/share/classes/java/nio/channels/SelectableChannel.java b/src/share/classes/java/nio/channels/SelectableChannel.java index 8b7c71257..35569e86e 100644 --- a/src/share/classes/java/nio/channels/SelectableChannel.java +++ b/src/share/classes/java/nio/channels/SelectableChannel.java @@ -208,7 +208,7 @@ public abstract class SelectableChannel * @throws IllegalArgumentException * If a bit in the ops set does not correspond to an * operation that is supported by this channel, that is, if - * set & ~validOps() != 0 + * {@code set & ~validOps() != 0} * * @return A key representing the registration of this channel with * the given selector @@ -265,8 +265,8 @@ public abstract class SelectableChannel * * @throws IllegalArgumentException * If a bit in ops does not correspond to an operation - * that is supported by this channel, that is, if set & - * ~validOps() != 0 + * that is supported by this channel, that is, if {@code set & + * ~validOps() != 0} * * @return A key representing the registration of this channel with * the given selector diff --git a/src/share/classes/java/nio/channels/SelectionKey.java b/src/share/classes/java/nio/channels/SelectionKey.java index ee339db09..2280cb9e2 100644 --- a/src/share/classes/java/nio/channels/SelectionKey.java +++ b/src/share/classes/java/nio/channels/SelectionKey.java @@ -191,7 +191,7 @@ public abstract class SelectionKey { * @throws IllegalArgumentException * If a bit in the set does not correspond to an operation that * is supported by this key's channel, that is, if - * (ops & ~channel().validOps()) != 0 + * {@code (ops & ~channel().validOps()) != 0} * * @throws CancelledKeyException * If this key has been cancelled @@ -272,15 +272,15 @@ public abstract class SelectionKey { *

    An invocation of this method of the form k.isReadable() * behaves in exactly the same way as the expression * - *

    -     * k.readyOps() & OP_READ != 0
    + *
    {@code
    +     * k.readyOps() & OP_READ != 0
    +     * }
    * *

    If this key's channel does not support read operations then this * method always returns false.

    * * @return true if, and only if, - * readyOps() & OP_READ is - * nonzero + {@code readyOps() & OP_READ} is nonzero * * @throws CancelledKeyException * If this key has been cancelled @@ -295,15 +295,15 @@ public abstract class SelectionKey { *

    An invocation of this method of the form k.isWritable() * behaves in exactly the same way as the expression * - *

    -     * k.readyOps() & OP_WRITE != 0
    + *
    {@code
    +     * k.readyOps() & OP_WRITE != 0
    +     * }
    * *

    If this key's channel does not support write operations then this * method always returns false.

    * * @return true if, and only if, - * readyOps() & OP_WRITE - * is nonzero + * {@code readyOps() & OP_WRITE} is nonzero * * @throws CancelledKeyException * If this key has been cancelled @@ -319,15 +319,15 @@ public abstract class SelectionKey { *

    An invocation of this method of the form k.isConnectable() * behaves in exactly the same way as the expression * - *

    -     * k.readyOps() & OP_CONNECT != 0
    + *
    {@code
    +     * k.readyOps() & OP_CONNECT != 0
    +     * }
    * *

    If this key's channel does not support socket-connect operations * then this method always returns false.

    * * @return true if, and only if, - * readyOps() & OP_CONNECT - * is nonzero + * {@code readyOps() & OP_CONNECT} is nonzero * * @throws CancelledKeyException * If this key has been cancelled @@ -343,15 +343,15 @@ public abstract class SelectionKey { *

    An invocation of this method of the form k.isAcceptable() * behaves in exactly the same way as the expression * - *

    -     * k.readyOps() & OP_ACCEPT != 0
    + *
    {@code
    +     * k.readyOps() & OP_ACCEPT != 0
    +     * }
    * *

    If this key's channel does not support socket-accept operations then * this method always returns false.

    * * @return true if, and only if, - * readyOps() & OP_ACCEPT - * is nonzero + * {@code readyOps() & OP_ACCEPT} is nonzero * * @throws CancelledKeyException * If this key has been cancelled 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 2449d56cf..8b115cc0f 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 @@ -260,7 +260,7 @@ public abstract class Charset$Coder$ { * method, passing the new replacement, after checking that the new * replacement is acceptable.

    * - * @param newReplacement + * @param newReplacement The replacement value * #if[decoder] * The new replacement; must not be null @@ -305,7 +305,7 @@ public abstract class Charset$Coder$ { * should be overridden by $coder$s that require notification of changes to * the replacement.

    * - * @param newReplacement + * @param newReplacement The replacement value */ protected void implReplaceWith($replType$ newReplacement) { } diff --git a/src/share/classes/java/nio/file/Path.java b/src/share/classes/java/nio/file/Path.java index a7933a348..577827658 100644 --- a/src/share/classes/java/nio/file/Path.java +++ b/src/share/classes/java/nio/file/Path.java @@ -64,7 +64,7 @@ import java.util.Iterator; * those developing custom file system implementations. Methods may be added to * this interface in future releases.

    * - *

    Accessing Files

    + *

    Accessing Files

    *

    Paths may be used with the {@link Files} class to operate on files, * directories, and other types of files. For example, suppose we want a {@link * java.io.BufferedReader} to read text from a file "{@code access.log}". The @@ -87,7 +87,7 @@ import java.util.Iterator; * addition, the {@link #toFile toFile} method is useful to construct a {@code * File} from the {@code String} representation of a {@code Path}. * - *

    Concurrency

    + *

    Concurrency

    *

    Implementations of this interface are immutable and safe for use by * multiple concurrent threads. * diff --git a/src/share/classes/java/security/KeyStore.java b/src/share/classes/java/security/KeyStore.java index 75d405771..5f1482c75 100644 --- a/src/share/classes/java/security/KeyStore.java +++ b/src/share/classes/java/security/KeyStore.java @@ -317,7 +317,7 @@ public class KeyStore { * been specified by properties in the domain configuration data. * It is cloned to prevent subsequent modification. * - * @exception NullPointerExcetion if {@code configuration} or + * @exception NullPointerException if {@code configuration} or * {@code protectionParams} is {@code null} */ public DomainLoadStoreParameter(URI configuration, diff --git a/src/share/classes/java/security/SecureRandom.java b/src/share/classes/java/security/SecureRandom.java index 1b4872fa6..7d25b147e 100644 --- a/src/share/classes/java/security/SecureRandom.java +++ b/src/share/classes/java/security/SecureRandom.java @@ -466,7 +466,7 @@ public class SecureRandom extends java.util.Random { * nextLong, and nextFloat). * * @param numBits number of pseudo-random bits to be generated, where - * 0 <= numBits <= 32. + * {@code 0 <= numBits <= 32}. * * @return an int containing the user-specified number * of pseudo-random bits (right justified, with leading zeros). diff --git a/src/share/classes/java/security/cert/CertPathValidatorException.java b/src/share/classes/java/security/cert/CertPathValidatorException.java index 9eedb620d..03cae751a 100644 --- a/src/share/classes/java/security/cert/CertPathValidatorException.java +++ b/src/share/classes/java/security/cert/CertPathValidatorException.java @@ -141,8 +141,8 @@ public class CertPathValidatorException extends GeneralSecurityException { * that caused the error (or -1 if not applicable). Note that * the list of certificates in a CertPath is zero based. * @throws IndexOutOfBoundsException if the index is out of range - * (index < -1 || (certPath != null && index >= - * certPath.getCertificates().size()) + * {@code (index < -1 || (certPath != null && index >= + * certPath.getCertificates().size()) } * @throws IllegalArgumentException if certPath is * null and index is not -1 */ @@ -164,8 +164,8 @@ public class CertPathValidatorException extends GeneralSecurityException { * the list of certificates in a CertPath is zero based. * @param reason the reason the validation failed * @throws IndexOutOfBoundsException if the index is out of range - * (index < -1 || (certPath != null && index >= - * certPath.getCertificates().size()) + * {@code (index < -1 || (certPath != null && index >= + * certPath.getCertificates().size()) } * @throws IllegalArgumentException if certPath is * null and index is not -1 * @throws NullPointerException if reason is null diff --git a/src/share/classes/java/security/cert/CertificateFactory.java b/src/share/classes/java/security/cert/CertificateFactory.java index 57a3fe15f..d0762df16 100644 --- a/src/share/classes/java/security/cert/CertificateFactory.java +++ b/src/share/classes/java/security/cert/CertificateFactory.java @@ -65,7 +65,7 @@ import sun.security.jca.GetInstance.Instance; * read position of the input stream is positioned to the next certificate in * the file:

    * - *

    + * 
    {@code
      * FileInputStream fis = new FileInputStream(filename);
      * BufferedInputStream bis = new BufferedInputStream(fis);
      *
    @@ -75,7 +75,7 @@ import sun.security.jca.GetInstance.Instance;
      *    Certificate cert = cf.generateCertificate(bis);
      *    System.out.println(cert.toString());
      * }
    - * 
    + * }
    * *

    The following example parses a PKCS#7-formatted certificate reply stored * in a file and extracts all the certificates from it:

    diff --git a/src/share/classes/java/security/cert/X509Extension.java b/src/share/classes/java/security/cert/X509Extension.java index e2c362ee3..ee63e6623 100644 --- a/src/share/classes/java/security/cert/X509Extension.java +++ b/src/share/classes/java/security/cert/X509Extension.java @@ -84,12 +84,12 @@ public interface X509Extension { * * Here is sample code to get a Set of critical extensions from an * X509Certificate and print the OIDs: - *

    
    +     * 
    {@code
          * X509Certificate cert = null;
          * try (InputStream inStrm = new FileInputStream("DER-encoded-Cert")) {
          *     CertificateFactory cf = CertificateFactory.getInstance("X.509");
          *     cert = (X509Certificate)cf.generateCertificate(inStrm);
    -     * }

    + * } * * Set critSet = cert.getCriticalExtensionOIDs(); * if (critSet != null && !critSet.isEmpty()) { @@ -98,7 +98,7 @@ public interface X509Extension { * System.out.println(oid); * } * } - *

    + * }
    * @return a Set (or an empty Set if none are marked critical) of * the extension OID strings for extensions that are marked critical. * If there are no extensions present at all, then this method returns diff --git a/src/share/classes/java/security/spec/EllipticCurve.java b/src/share/classes/java/security/spec/EllipticCurve.java index a270ee724..d9eef25ca 100644 --- a/src/share/classes/java/security/spec/EllipticCurve.java +++ b/src/share/classes/java/security/spec/EllipticCurve.java @@ -184,9 +184,9 @@ public class EllipticCurve { * Returns a hash code value for this elliptic curve. * @return a hash code value computed from the hash codes of the field, A, * and B, as follows: - * + *
    {@code
          *     (field.hashCode() << 6) + (a.hashCode() << 4) + (b.hashCode() << 2)
    -     * 
    +     * }
    */ public int hashCode() { return (field.hashCode() << 6 + diff --git a/src/share/classes/java/sql/DatabaseMetaData.java b/src/share/classes/java/sql/DatabaseMetaData.java index 7330b8eac..035365512 100644 --- a/src/share/classes/java/sql/DatabaseMetaData.java +++ b/src/share/classes/java/sql/DatabaseMetaData.java @@ -1218,21 +1218,21 @@ public interface DatabaseMetaData extends Wrapper { * *

    Each procedure description has the the following columns: *

      - *
    1. PROCEDURE_CAT String => procedure catalog (may be null) - *
    2. PROCEDURE_SCHEM String => procedure schema (may be null) - *
    3. PROCEDURE_NAME String => procedure name + *
    4. PROCEDURE_CAT String {@code =>} procedure catalog (may be null) + *
    5. PROCEDURE_SCHEM String {@code =>} procedure schema (may be null) + *
    6. PROCEDURE_NAME String {@code =>} procedure name *
    7. reserved for future use *
    8. reserved for future use *
    9. reserved for future use - *
    10. REMARKS String => explanatory comment on the procedure - *
    11. PROCEDURE_TYPE short => kind of procedure: + *
    12. REMARKS String {@code =>} explanatory comment on the procedure + *
    13. PROCEDURE_TYPE short {@code =>} kind of procedure: *
        *
      • procedureResultUnknown - Cannot determine if a return value * will be returned *
      • procedureNoResult - Does not return a return value *
      • procedureReturnsResult - Returns a return value *
      - *
    14. SPECIFIC_NAME String => The name which uniquely identifies this + *
    15. SPECIFIC_NAME String {@code =>} The name which uniquely identifies this * procedure within its schema. *
    *

    @@ -1297,11 +1297,11 @@ public interface DatabaseMetaData extends Wrapper { *

    Each row in the ResultSet is a parameter description or * column description with the following fields: *

      - *
    1. PROCEDURE_CAT String => procedure catalog (may be null) - *
    2. PROCEDURE_SCHEM String => procedure schema (may be null) - *
    3. PROCEDURE_NAME String => procedure name - *
    4. COLUMN_NAME String => column/parameter name - *
    5. COLUMN_TYPE Short => kind of column/parameter: + *
    6. PROCEDURE_CAT String {@code =>} procedure catalog (may be null) + *
    7. PROCEDURE_SCHEM String {@code =>} procedure schema (may be null) + *
    8. PROCEDURE_NAME String {@code =>} procedure name + *
    9. COLUMN_NAME String {@code =>} column/parameter name + *
    10. COLUMN_TYPE Short {@code =>} kind of column/parameter: *
        *
      • procedureColumnUnknown - nobody knows *
      • procedureColumnIn - IN parameter @@ -1310,44 +1310,44 @@ public interface DatabaseMetaData extends Wrapper { *
      • procedureColumnReturn - procedure return value *
      • procedureColumnResult - result column in ResultSet *
      - *
    11. DATA_TYPE int => SQL type from java.sql.Types - *
    12. TYPE_NAME String => SQL type name, for a UDT type the + *
    13. DATA_TYPE int {@code =>} SQL type from java.sql.Types + *
    14. TYPE_NAME String {@code =>} SQL type name, for a UDT type the * type name is fully qualified - *
    15. PRECISION int => precision - *
    16. LENGTH int => length in bytes of data - *
    17. SCALE short => scale - null is returned for data types where + *
    18. PRECISION int {@code =>} precision + *
    19. LENGTH int {@code =>} length in bytes of data + *
    20. SCALE short {@code =>} scale - null is returned for data types where * SCALE is not applicable. - *
    21. RADIX short => radix - *
    22. NULLABLE short => can it contain NULL. + *
    23. RADIX short {@code =>} radix + *
    24. NULLABLE short {@code =>} can it contain NULL. *
        *
      • procedureNoNulls - does not allow NULL values *
      • procedureNullable - allows NULL values *
      • procedureNullableUnknown - nullability unknown *
      - *
    25. REMARKS String => comment describing parameter/column - *
    26. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) + *
    27. REMARKS String {@code =>} comment describing parameter/column + *
    28. COLUMN_DEF String {@code =>} default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) *
        *
      • The string NULL (not enclosed in quotes) - if NULL was specified as the default value *
      • TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation *
      • NULL - if a default value was not specified *
      - *
    29. SQL_DATA_TYPE int => reserved for future use - *
    30. SQL_DATETIME_SUB int => reserved for future use - *
    31. CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a + *
    32. SQL_DATA_TYPE int {@code =>} reserved for future use + *
    33. SQL_DATETIME_SUB int {@code =>} reserved for future use + *
    34. CHAR_OCTET_LENGTH int {@code =>} the maximum length of binary and character based columns. For any other datatype the returned value is a * NULL - *
    35. ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 + *
    36. ORDINAL_POSITION int {@code =>} the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 *is returned if this row describes the procedure's return value. For result set columns, it is the *ordinal position of the column in the result set starting from 1. If there are *multiple result sets, the column ordinal positions are implementation * defined. - *
    37. IS_NULLABLE String => ISO rules are used to determine the nullability for a column. + *
    38. IS_NULLABLE String {@code =>} ISO rules are used to determine the nullability for a column. *
        *
      • YES --- if the column can include NULLs *
      • NO --- if the column cannot include NULLs *
      • empty string --- if the nullability for the * column is unknown *
      - *
    39. SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema. + *
    40. SPECIFIC_NAME String {@code =>} the name which uniquely identifies this procedure within its schema. *
    * *

    Note: Some databases may not return the column @@ -1481,19 +1481,19 @@ public interface DatabaseMetaData extends Wrapper { *

    * Each table description has the following columns: *

      - *
    1. TABLE_CAT String => table catalog (may be null) - *
    2. TABLE_SCHEM String => table schema (may be null) - *
    3. TABLE_NAME String => table name - *
    4. TABLE_TYPE String => table type. Typical types are "TABLE", + *
    5. TABLE_CAT String {@code =>} table catalog (may be null) + *
    6. TABLE_SCHEM String {@code =>} table schema (may be null) + *
    7. TABLE_NAME String {@code =>} table name + *
    8. TABLE_TYPE String {@code =>} table type. Typical types are "TABLE", * "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", * "LOCAL TEMPORARY", "ALIAS", "SYNONYM". - *
    9. REMARKS String => explanatory comment on the table - *
    10. TYPE_CAT String => the types catalog (may be null) - *
    11. TYPE_SCHEM String => the types schema (may be null) - *
    12. TYPE_NAME String => type name (may be null) - *
    13. SELF_REFERENCING_COL_NAME String => name of the designated + *
    14. REMARKS String {@code =>} explanatory comment on the table + *
    15. TYPE_CAT String {@code =>} the types catalog (may be null) + *
    16. TYPE_SCHEM String {@code =>} the types schema (may be null) + *
    17. TYPE_NAME String {@code =>} type name (may be null) + *
    18. SELF_REFERENCING_COL_NAME String {@code =>} name of the designated * "identifier" column of a typed table (may be null) - *
    19. REF_GENERATION String => specifies how values in + *
    20. REF_GENERATION String {@code =>} specifies how values in * SELF_REFERENCING_COL_NAME are created. Values are * "SYSTEM", "USER", "DERIVED". (may be null) *
    @@ -1528,8 +1528,8 @@ public interface DatabaseMetaData extends Wrapper { * *

    The schema columns are: *

      - *
    1. TABLE_SCHEM String => schema name - *
    2. TABLE_CATALOG String => catalog name (may be null) + *
    3. TABLE_SCHEM String {@code =>} schema name + *
    4. TABLE_CATALOG String {@code =>} catalog name (may be null) *
    * * @return a ResultSet object in which each row is a @@ -1545,7 +1545,7 @@ public interface DatabaseMetaData extends Wrapper { * *

    The catalog column is: *

      - *
    1. TABLE_CAT String => catalog name + *
    2. TABLE_CAT String {@code =>} catalog name *
    * * @return a ResultSet object in which each row has a @@ -1560,7 +1560,7 @@ public interface DatabaseMetaData extends Wrapper { * *

    The table type is: *

      - *
    1. TABLE_TYPE String => table type. Typical types are "TABLE", + *
    2. TABLE_TYPE String {@code =>} table type. Typical types are "TABLE", * "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", * "LOCAL TEMPORARY", "ALIAS", "SYNONYM". *
    @@ -1582,55 +1582,55 @@ public interface DatabaseMetaData extends Wrapper { * *

    Each column description has the following columns: *

      - *
    1. TABLE_CAT String => table catalog (may be null) - *
    2. TABLE_SCHEM String => table schema (may be null) - *
    3. TABLE_NAME String => table name - *
    4. COLUMN_NAME String => column name - *
    5. DATA_TYPE int => SQL type from java.sql.Types - *
    6. TYPE_NAME String => Data source dependent type name, + *
    7. TABLE_CAT String {@code =>} table catalog (may be null) + *
    8. TABLE_SCHEM String {@code =>} table schema (may be null) + *
    9. TABLE_NAME String {@code =>} table name + *
    10. COLUMN_NAME String {@code =>} column name + *
    11. DATA_TYPE int {@code =>} SQL type from java.sql.Types + *
    12. TYPE_NAME String {@code =>} Data source dependent type name, * for a UDT the type name is fully qualified - *
    13. COLUMN_SIZE int => column size. + *
    14. COLUMN_SIZE int {@code =>} column size. *
    15. BUFFER_LENGTH is not used. - *
    16. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where + *
    17. DECIMAL_DIGITS int {@code =>} the number of fractional digits. Null is returned for data types where * DECIMAL_DIGITS is not applicable. - *
    18. NUM_PREC_RADIX int => Radix (typically either 10 or 2) - *
    19. NULLABLE int => is NULL allowed. + *
    20. NUM_PREC_RADIX int {@code =>} Radix (typically either 10 or 2) + *
    21. NULLABLE int {@code =>} is NULL allowed. *
        *
      • columnNoNulls - might not allow NULL values *
      • columnNullable - definitely allows NULL values *
      • columnNullableUnknown - nullability unknown *
      - *
    22. REMARKS String => comment describing column (may be null) - *
    23. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) - *
    24. SQL_DATA_TYPE int => unused - *
    25. SQL_DATETIME_SUB int => unused - *
    26. CHAR_OCTET_LENGTH int => for char types the + *
    27. REMARKS String {@code =>} comment describing column (may be null) + *
    28. COLUMN_DEF String {@code =>} default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) + *
    29. SQL_DATA_TYPE int {@code =>} unused + *
    30. SQL_DATETIME_SUB int {@code =>} unused + *
    31. CHAR_OCTET_LENGTH int {@code =>} for char types the * maximum number of bytes in the column - *
    32. ORDINAL_POSITION int => index of column in table + *
    33. ORDINAL_POSITION int {@code =>} index of column in table * (starting at 1) - *
    34. IS_NULLABLE String => ISO rules are used to determine the nullability for a column. + *
    35. IS_NULLABLE String {@code =>} ISO rules are used to determine the nullability for a column. *
        *
      • YES --- if the column can include NULLs *
      • NO --- if the column cannot include NULLs *
      • empty string --- if the nullability for the * column is unknown *
      - *
    36. SCOPE_CATALOG String => catalog of table that is the scope + *
    37. SCOPE_CATALOG String {@code =>} catalog of table that is the scope * of a reference attribute (null if DATA_TYPE isn't REF) - *
    38. SCOPE_SCHEMA String => schema of table that is the scope + *
    39. SCOPE_SCHEMA String {@code =>} schema of table that is the scope * of a reference attribute (null if the DATA_TYPE isn't REF) - *
    40. SCOPE_TABLE String => table name that this the scope + *
    41. SCOPE_TABLE String {@code =>} table name that this the scope * of a reference attribute (null if the DATA_TYPE isn't REF) - *
    42. SOURCE_DATA_TYPE short => source type of a distinct type or user-generated + *
    43. SOURCE_DATA_TYPE short {@code =>} source type of a distinct type or user-generated * Ref type, SQL type from java.sql.Types (null if DATA_TYPE * isn't DISTINCT or user-generated REF) - *
    44. IS_AUTOINCREMENT String => Indicates whether this column is auto incremented + *
    45. IS_AUTOINCREMENT String {@code =>} Indicates whether this column is auto incremented *
        *
      • YES --- if the column is auto incremented *
      • NO --- if the column is not auto incremented *
      • empty string --- if it cannot be determined whether the column is auto incremented *
      - *
    46. IS_GENERATEDCOLUMN String => Indicates whether this is a generated column + *
    47. IS_GENERATEDCOLUMN String {@code =>} Indicates whether this is a generated column *
        *
      • YES --- if this a generated column *
      • NO --- if this not a generated column @@ -1703,15 +1703,15 @@ public interface DatabaseMetaData extends Wrapper { * *

        Each privilige description has the following columns: *

          - *
        1. TABLE_CAT String => table catalog (may be null) - *
        2. TABLE_SCHEM String => table schema (may be null) - *
        3. TABLE_NAME String => table name - *
        4. COLUMN_NAME String => column name - *
        5. GRANTOR String => grantor of access (may be null) - *
        6. GRANTEE String => grantee of access - *
        7. PRIVILEGE String => name of access (SELECT, + *
        8. TABLE_CAT String {@code =>} table catalog (may be null) + *
        9. TABLE_SCHEM String {@code =>} table schema (may be null) + *
        10. TABLE_NAME String {@code =>} table name + *
        11. COLUMN_NAME String {@code =>} column name + *
        12. GRANTOR String {@code =>} grantor of access (may be null) + *
        13. GRANTEE String {@code =>} grantee of access + *
        14. PRIVILEGE String {@code =>} name of access (SELECT, * INSERT, UPDATE, REFRENCES, ...) - *
        15. IS_GRANTABLE String => "YES" if grantee is permitted + *
        16. IS_GRANTABLE String {@code =>} "YES" if grantee is permitted * to grant to others; "NO" if not; null if unknown *
        * @@ -1749,14 +1749,14 @@ public interface DatabaseMetaData extends Wrapper { * *

        Each privilige description has the following columns: *

          - *
        1. TABLE_CAT String => table catalog (may be null) - *
        2. TABLE_SCHEM String => table schema (may be null) - *
        3. TABLE_NAME String => table name - *
        4. GRANTOR String => grantor of access (may be null) - *
        5. GRANTEE String => grantee of access - *
        6. PRIVILEGE String => name of access (SELECT, + *
        7. TABLE_CAT String {@code =>} table catalog (may be null) + *
        8. TABLE_SCHEM String {@code =>} table schema (may be null) + *
        9. TABLE_NAME String {@code =>} table name + *
        10. GRANTOR String {@code =>} grantor of access (may be null) + *
        11. GRANTEE String {@code =>} grantee of access + *
        12. PRIVILEGE String {@code =>} name of access (SELECT, * INSERT, UPDATE, REFRENCES, ...) - *
        13. IS_GRANTABLE String => "YES" if grantee is permitted + *
        14. IS_GRANTABLE String {@code =>} "YES" if grantee is permitted * to grant to others; "NO" if not; null if unknown *
        * @@ -1783,21 +1783,21 @@ public interface DatabaseMetaData extends Wrapper { * *

        Each column description has the following columns: *

          - *
        1. SCOPE short => actual scope of result + *
        2. SCOPE short {@code =>} actual scope of result *
            *
          • bestRowTemporary - very temporary, while using row *
          • bestRowTransaction - valid for remainder of current transaction *
          • bestRowSession - valid for remainder of current session *
          - *
        3. COLUMN_NAME String => column name - *
        4. DATA_TYPE int => SQL data type from java.sql.Types - *
        5. TYPE_NAME String => Data source dependent type name, + *
        6. COLUMN_NAME String {@code =>} column name + *
        7. DATA_TYPE int {@code =>} SQL data type from java.sql.Types + *
        8. TYPE_NAME String {@code =>} Data source dependent type name, * for a UDT the type name is fully qualified - *
        9. COLUMN_SIZE int => precision - *
        10. BUFFER_LENGTH int => not used - *
        11. DECIMAL_DIGITS short => scale - Null is returned for data types where + *
        12. COLUMN_SIZE int {@code =>} precision + *
        13. BUFFER_LENGTH int {@code =>} not used + *
        14. DECIMAL_DIGITS short {@code =>} scale - Null is returned for data types where * DECIMAL_DIGITS is not applicable. - *
        15. PSEUDO_COLUMN short => is this a pseudo column + *
        16. PSEUDO_COLUMN short {@code =>} is this a pseudo column * like an Oracle ROWID *
            *
          • bestRowUnknown - may or may not be pseudo column @@ -1902,15 +1902,15 @@ public interface DatabaseMetaData extends Wrapper { * *

            Each column description has the following columns: *

              - *
            1. SCOPE short => is not used - *
            2. COLUMN_NAME String => column name - *
            3. DATA_TYPE int => SQL data type from java.sql.Types - *
            4. TYPE_NAME String => Data source-dependent type name - *
            5. COLUMN_SIZE int => precision - *
            6. BUFFER_LENGTH int => length of column value in bytes - *
            7. DECIMAL_DIGITS short => scale - Null is returned for data types where + *
            8. SCOPE short {@code =>} is not used + *
            9. COLUMN_NAME String {@code =>} column name + *
            10. DATA_TYPE int {@code =>} SQL data type from java.sql.Types + *
            11. TYPE_NAME String {@code =>} Data source-dependent type name + *
            12. COLUMN_SIZE int {@code =>} precision + *
            13. BUFFER_LENGTH int {@code =>} length of column value in bytes + *
            14. DECIMAL_DIGITS short {@code =>} scale - Null is returned for data types where * DECIMAL_DIGITS is not applicable. - *
            15. PSEUDO_COLUMN short => whether this is pseudo column + *
            16. PSEUDO_COLUMN short {@code =>} whether this is pseudo column * like an Oracle ROWID *
                *
              • versionColumnUnknown - may or may not be pseudo column @@ -1978,14 +1978,14 @@ public interface DatabaseMetaData extends Wrapper { * *

                Each primary key column description has the following columns: *

                  - *
                1. TABLE_CAT String => table catalog (may be null) - *
                2. TABLE_SCHEM String => table schema (may be null) - *
                3. TABLE_NAME String => table name - *
                4. COLUMN_NAME String => column name - *
                5. KEY_SEQ short => sequence number within primary key( a value + *
                6. TABLE_CAT String {@code =>} table catalog (may be null) + *
                7. TABLE_SCHEM String {@code =>} table schema (may be null) + *
                8. TABLE_NAME String {@code =>} table name + *
                9. COLUMN_NAME String {@code =>} column name + *
                10. KEY_SEQ short {@code =>} sequence number within primary key( a value * of 1 represents the first column of the primary key, a value of 2 would * represent the second column within the primary key). - *
                11. PK_NAME String => primary key name (may be null) + *
                12. PK_NAME String {@code =>} primary key name (may be null) *
                * * @param catalog a catalog name; must match the catalog name as it @@ -2012,22 +2012,22 @@ public interface DatabaseMetaData extends Wrapper { * *

                Each primary key column description has the following columns: *

                  - *
                1. PKTABLE_CAT String => primary key table catalog + *
                2. PKTABLE_CAT String {@code =>} primary key table catalog * being imported (may be null) - *
                3. PKTABLE_SCHEM String => primary key table schema + *
                4. PKTABLE_SCHEM String {@code =>} primary key table schema * being imported (may be null) - *
                5. PKTABLE_NAME String => primary key table name + *
                6. PKTABLE_NAME String {@code =>} primary key table name * being imported - *
                7. PKCOLUMN_NAME String => primary key column name + *
                8. PKCOLUMN_NAME String {@code =>} primary key column name * being imported - *
                9. FKTABLE_CAT String => foreign key table catalog (may be null) - *
                10. FKTABLE_SCHEM String => foreign key table schema (may be null) - *
                11. FKTABLE_NAME String => foreign key table name - *
                12. FKCOLUMN_NAME String => foreign key column name - *
                13. KEY_SEQ short => sequence number within a foreign key( a value + *
                14. FKTABLE_CAT String {@code =>} foreign key table catalog (may be null) + *
                15. FKTABLE_SCHEM String {@code =>} foreign key table schema (may be null) + *
                16. FKTABLE_NAME String {@code =>} foreign key table name + *
                17. FKCOLUMN_NAME String {@code =>} foreign key column name + *
                18. KEY_SEQ short {@code =>} sequence number within a foreign key( a value * of 1 represents the first column of the foreign key, a value of 2 would * represent the second column within the foreign key). - *
                19. UPDATE_RULE short => What happens to a + *
                20. UPDATE_RULE short {@code =>} What happens to a * foreign key when the primary key is updated: *
                    *
                  • importedNoAction - do not allow update of primary @@ -2041,7 +2041,7 @@ public interface DatabaseMetaData extends Wrapper { *
                  • importedKeyRestrict - same as importedKeyNoAction * (for ODBC 2.x compatibility) *
                  - *
                21. DELETE_RULE short => What happens to + *
                22. DELETE_RULE short {@code =>} What happens to * the foreign key when primary is deleted. *
                    *
                  • importedKeyNoAction - do not allow delete of primary @@ -2054,9 +2054,9 @@ public interface DatabaseMetaData extends Wrapper { *
                  • importedKeySetDefault - change imported key to default if * its primary key has been deleted *
                  - *
                23. FK_NAME String => foreign key name (may be null) - *
                24. PK_NAME String => primary key name (may be null) - *
                25. DEFERRABILITY short => can the evaluation of foreign key + *
                26. FK_NAME String {@code =>} foreign key name (may be null) + *
                27. PK_NAME String {@code =>} primary key name (may be null) + *
                28. DEFERRABILITY short {@code =>} can the evaluation of foreign key * constraints be deferred until commit *
                    *
                  • importedKeyInitiallyDeferred - see SQL92 for definition @@ -2195,22 +2195,22 @@ public interface DatabaseMetaData extends Wrapper { * *

                    Each foreign key column description has the following columns: *

                      - *
                    1. PKTABLE_CAT String => primary key table catalog (may be null) - *
                    2. PKTABLE_SCHEM String => primary key table schema (may be null) - *
                    3. PKTABLE_NAME String => primary key table name - *
                    4. PKCOLUMN_NAME String => primary key column name - *
                    5. FKTABLE_CAT String => foreign key table catalog (may be null) + *
                    6. PKTABLE_CAT String {@code =>} primary key table catalog (may be null) + *
                    7. PKTABLE_SCHEM String {@code =>} primary key table schema (may be null) + *
                    8. PKTABLE_NAME String {@code =>} primary key table name + *
                    9. PKCOLUMN_NAME String {@code =>} primary key column name + *
                    10. FKTABLE_CAT String {@code =>} foreign key table catalog (may be null) * being exported (may be null) - *
                    11. FKTABLE_SCHEM String => foreign key table schema (may be null) + *
                    12. FKTABLE_SCHEM String {@code =>} foreign key table schema (may be null) * being exported (may be null) - *
                    13. FKTABLE_NAME String => foreign key table name + *
                    14. FKTABLE_NAME String {@code =>} foreign key table name * being exported - *
                    15. FKCOLUMN_NAME String => foreign key column name + *
                    16. FKCOLUMN_NAME String {@code =>} foreign key column name * being exported - *
                    17. KEY_SEQ short => sequence number within foreign key( a value + *
                    18. KEY_SEQ short {@code =>} sequence number within foreign key( a value * of 1 represents the first column of the foreign key, a value of 2 would * represent the second column within the foreign key). - *
                    19. UPDATE_RULE short => What happens to + *
                    20. UPDATE_RULE short {@code =>} What happens to * foreign key when primary is updated: *
                        *
                      • importedNoAction - do not allow update of primary @@ -2224,7 +2224,7 @@ public interface DatabaseMetaData extends Wrapper { *
                      • importedKeyRestrict - same as importedKeyNoAction * (for ODBC 2.x compatibility) *
                      - *
                    21. DELETE_RULE short => What happens to + *
                    22. DELETE_RULE short {@code =>} What happens to * the foreign key when primary is deleted. *
                        *
                      • importedKeyNoAction - do not allow delete of primary @@ -2237,9 +2237,9 @@ public interface DatabaseMetaData extends Wrapper { *
                      • importedKeySetDefault - change imported key to default if * its primary key has been deleted *
                      - *
                    23. FK_NAME String => foreign key name (may be null) - *
                    24. PK_NAME String => primary key name (may be null) - *
                    25. DEFERRABILITY short => can the evaluation of foreign key + *
                    26. FK_NAME String {@code =>} foreign key name (may be null) + *
                    27. PK_NAME String {@code =>} primary key name (may be null) + *
                    28. DEFERRABILITY short {@code =>} can the evaluation of foreign key * constraints be deferred until commit *
                        *
                      • importedKeyInitiallyDeferred - see SQL92 for definition @@ -2276,22 +2276,22 @@ public interface DatabaseMetaData extends Wrapper { * *

                        Each foreign key column description has the following columns: *

                          - *
                        1. PKTABLE_CAT String => parent key table catalog (may be null) - *
                        2. PKTABLE_SCHEM String => parent key table schema (may be null) - *
                        3. PKTABLE_NAME String => parent key table name - *
                        4. PKCOLUMN_NAME String => parent key column name - *
                        5. FKTABLE_CAT String => foreign key table catalog (may be null) + *
                        6. PKTABLE_CAT String {@code =>} parent key table catalog (may be null) + *
                        7. PKTABLE_SCHEM String {@code =>} parent key table schema (may be null) + *
                        8. PKTABLE_NAME String {@code =>} parent key table name + *
                        9. PKCOLUMN_NAME String {@code =>} parent key column name + *
                        10. FKTABLE_CAT String {@code =>} foreign key table catalog (may be null) * being exported (may be null) - *
                        11. FKTABLE_SCHEM String => foreign key table schema (may be null) + *
                        12. FKTABLE_SCHEM String {@code =>} foreign key table schema (may be null) * being exported (may be null) - *
                        13. FKTABLE_NAME String => foreign key table name + *
                        14. FKTABLE_NAME String {@code =>} foreign key table name * being exported - *
                        15. FKCOLUMN_NAME String => foreign key column name + *
                        16. FKCOLUMN_NAME String {@code =>} foreign key column name * being exported - *
                        17. KEY_SEQ short => sequence number within foreign key( a value + *
                        18. KEY_SEQ short {@code =>} sequence number within foreign key( a value * of 1 represents the first column of the foreign key, a value of 2 would * represent the second column within the foreign key). - *
                        19. UPDATE_RULE short => What happens to + *
                        20. UPDATE_RULE short {@code =>} What happens to * foreign key when parent key is updated: *
                            *
                          • importedNoAction - do not allow update of parent @@ -2305,7 +2305,7 @@ public interface DatabaseMetaData extends Wrapper { *
                          • importedKeyRestrict - same as importedKeyNoAction * (for ODBC 2.x compatibility) *
                          - *
                        21. DELETE_RULE short => What happens to + *
                        22. DELETE_RULE short {@code =>} What happens to * the foreign key when parent key is deleted. *
                            *
                          • importedKeyNoAction - do not allow delete of parent @@ -2318,9 +2318,9 @@ public interface DatabaseMetaData extends Wrapper { *
                          • importedKeySetDefault - change imported key to default if * its parent key has been deleted *
                          - *
                        23. FK_NAME String => foreign key name (may be null) - *
                        24. PK_NAME String => parent key name (may be null) - *
                        25. DEFERRABILITY short => can the evaluation of foreign key + *
                        26. FK_NAME String {@code =>} foreign key name (may be null) + *
                        27. PK_NAME String {@code =>} parent key name (may be null) + *
                        28. DEFERRABILITY short {@code =>} can the evaluation of foreign key * constraints be deferred until commit *
                            *
                          • importedKeyInitiallyDeferred - see SQL92 for definition @@ -2371,40 +2371,40 @@ public interface DatabaseMetaData extends Wrapper { * *

                            Each type description has the following columns: *

                              - *
                            1. TYPE_NAME String => Type name - *
                            2. DATA_TYPE int => SQL data type from java.sql.Types - *
                            3. PRECISION int => maximum precision - *
                            4. LITERAL_PREFIX String => prefix used to quote a literal + *
                            5. TYPE_NAME String {@code =>} Type name + *
                            6. DATA_TYPE int {@code =>} SQL data type from java.sql.Types + *
                            7. PRECISION int {@code =>} maximum precision + *
                            8. LITERAL_PREFIX String {@code =>} prefix used to quote a literal * (may be null) - *
                            9. LITERAL_SUFFIX String => suffix used to quote a literal + *
                            10. LITERAL_SUFFIX String {@code =>} suffix used to quote a literal (may be null) - *
                            11. CREATE_PARAMS String => parameters used in creating + *
                            12. CREATE_PARAMS String {@code =>} parameters used in creating * the type (may be null) - *
                            13. NULLABLE short => can you use NULL for this type. + *
                            14. NULLABLE short {@code =>} can you use NULL for this type. *
                                *
                              • typeNoNulls - does not allow NULL values *
                              • typeNullable - allows NULL values *
                              • typeNullableUnknown - nullability unknown *
                              - *
                            15. CASE_SENSITIVE boolean=> is it case sensitive. - *
                            16. SEARCHABLE short => can you use "WHERE" based on this type: + *
                            17. CASE_SENSITIVE boolean{@code =>} is it case sensitive. + *
                            18. SEARCHABLE short {@code =>} can you use "WHERE" based on this type: *
                                *
                              • typePredNone - No support *
                              • typePredChar - Only supported with WHERE .. LIKE *
                              • typePredBasic - Supported except for WHERE .. LIKE *
                              • typeSearchable - Supported for all WHERE .. *
                              - *
                            19. UNSIGNED_ATTRIBUTE boolean => is it unsigned. - *
                            20. FIXED_PREC_SCALE boolean => can it be a money value. - *
                            21. AUTO_INCREMENT boolean => can it be used for an + *
                            22. UNSIGNED_ATTRIBUTE boolean {@code =>} is it unsigned. + *
                            23. FIXED_PREC_SCALE boolean {@code =>} can it be a money value. + *
                            24. AUTO_INCREMENT boolean {@code =>} can it be used for an * auto-increment value. - *
                            25. LOCAL_TYPE_NAME String => localized version of type name + *
                            26. LOCAL_TYPE_NAME String {@code =>} localized version of type name * (may be null) - *
                            27. MINIMUM_SCALE short => minimum scale supported - *
                            28. MAXIMUM_SCALE short => maximum scale supported - *
                            29. SQL_DATA_TYPE int => unused - *
                            30. SQL_DATETIME_SUB int => unused - *
                            31. NUM_PREC_RADIX int => usually 2 or 10 + *
                            32. MINIMUM_SCALE short {@code =>} minimum scale supported + *
                            33. MAXIMUM_SCALE short {@code =>} maximum scale supported + *
                            34. SQL_DATA_TYPE int {@code =>} unused + *
                            35. SQL_DATETIME_SUB int {@code =>} unused + *
                            36. NUM_PREC_RADIX int {@code =>} usually 2 or 10 *
                            * *

                            The PRECISION column represents the maximum column size that the server supports for the given datatype. @@ -2498,16 +2498,16 @@ public interface DatabaseMetaData extends Wrapper { * *

                            Each index column description has the following columns: *

                              - *
                            1. TABLE_CAT String => table catalog (may be null) - *
                            2. TABLE_SCHEM String => table schema (may be null) - *
                            3. TABLE_NAME String => table name - *
                            4. NON_UNIQUE boolean => Can index values be non-unique. + *
                            5. TABLE_CAT String {@code =>} table catalog (may be null) + *
                            6. TABLE_SCHEM String {@code =>} table schema (may be null) + *
                            7. TABLE_NAME String {@code =>} table name + *
                            8. NON_UNIQUE boolean {@code =>} Can index values be non-unique. * false when TYPE is tableIndexStatistic - *
                            9. INDEX_QUALIFIER String => index catalog (may be null); + *
                            10. INDEX_QUALIFIER String {@code =>} index catalog (may be null); * null when TYPE is tableIndexStatistic - *
                            11. INDEX_NAME String => index name; null when TYPE is + *
                            12. INDEX_NAME String {@code =>} index name; null when TYPE is * tableIndexStatistic - *
                            13. TYPE short => index type: + *
                            14. TYPE short {@code =>} index type: *
                                *
                              • tableIndexStatistic - this identifies table statistics that are * returned in conjuction with a table's index descriptions @@ -2515,20 +2515,20 @@ public interface DatabaseMetaData extends Wrapper { *
                              • tableIndexHashed - this is a hashed index *
                              • tableIndexOther - this is some other style of index *
                              - *
                            15. ORDINAL_POSITION short => column sequence number + *
                            16. ORDINAL_POSITION short {@code =>} column sequence number * within index; zero when TYPE is tableIndexStatistic - *
                            17. COLUMN_NAME String => column name; null when TYPE is + *
                            18. COLUMN_NAME String {@code =>} column name; null when TYPE is * tableIndexStatistic - *
                            19. ASC_OR_DESC String => column sort sequence, "A" => ascending, - * "D" => descending, may be null if sort sequence is not supported; + *
                            20. ASC_OR_DESC String {@code =>} column sort sequence, "A" {@code =>} ascending, + * "D" {@code =>} descending, may be null if sort sequence is not supported; * null when TYPE is tableIndexStatistic - *
                            21. CARDINALITY long => When TYPE is tableIndexStatistic, then + *
                            22. CARDINALITY long {@code =>} When TYPE is tableIndexStatistic, then * this is the number of rows in the table; otherwise, it is the * number of unique values in the index. - *
                            23. PAGES long => When TYPE is tableIndexStatisic then + *
                            24. PAGES long {@code =>} When TYPE is tableIndexStatisic then * this is the number of pages used for the table, otherwise it * is the number of pages used for the current index. - *
                            25. FILTER_CONDITION String => Filter condition, if any. + *
                            26. FILTER_CONDITION String {@code =>} Filter condition, if any. * (may be null) *
                            * @@ -2781,14 +2781,14 @@ public interface DatabaseMetaData extends Wrapper { * *

                            Each type description has the following columns: *

                              - *
                            1. TYPE_CAT String => the type's catalog (may be null) - *
                            2. TYPE_SCHEM String => type's schema (may be null) - *
                            3. TYPE_NAME String => type name - *
                            4. CLASS_NAME String => Java class name - *
                            5. DATA_TYPE int => type value defined in java.sql.Types. + *
                            6. TYPE_CAT String {@code =>} the type's catalog (may be null) + *
                            7. TYPE_SCHEM String {@code =>} type's schema (may be null) + *
                            8. TYPE_NAME String {@code =>} type name + *
                            9. CLASS_NAME String {@code =>} Java class name + *
                            10. DATA_TYPE int {@code =>} type value defined in java.sql.Types. * One of JAVA_OBJECT, STRUCT, or DISTINCT - *
                            11. REMARKS String => explanatory comment on the type - *
                            12. BASE_TYPE short => type code of the source type of a + *
                            13. REMARKS String {@code =>} explanatory comment on the type + *
                            14. BASE_TYPE short {@code =>} type code of the source type of a * DISTINCT type or the type that implements the user-generated * reference type of the SELF_REFERENCING_COLUMN of a structured * type as defined in java.sql.Types (null if DATA_TYPE is not @@ -2894,14 +2894,14 @@ public interface DatabaseMetaData extends Wrapper { * describes the designated UDT and a direct supertype. A row has the following * columns: *
                                - *
                              1. TYPE_CAT String => the UDT's catalog (may be null) - *
                              2. TYPE_SCHEM String => UDT's schema (may be null) - *
                              3. TYPE_NAME String => type name of the UDT - *
                              4. SUPERTYPE_CAT String => the direct super type's catalog + *
                              5. TYPE_CAT String {@code =>} the UDT's catalog (may be null) + *
                              6. TYPE_SCHEM String {@code =>} UDT's schema (may be null) + *
                              7. TYPE_NAME String {@code =>} type name of the UDT + *
                              8. SUPERTYPE_CAT String {@code =>} the direct super type's catalog * (may be null) - *
                              9. SUPERTYPE_SCHEM String => the direct super type's schema + *
                              10. SUPERTYPE_SCHEM String {@code =>} the direct super type's schema * (may be null) - *
                              11. SUPERTYPE_NAME String => the direct super type's name + *
                              12. SUPERTYPE_NAME String {@code =>} the direct super type's name *
                              * *

                              Note: If the driver does not support type hierarchies, an @@ -2936,10 +2936,10 @@ public interface DatabaseMetaData extends Wrapper { * *

                              Each type description has the following columns: *

                                - *
                              1. TABLE_CAT String => the type's catalog (may be null) - *
                              2. TABLE_SCHEM String => type's schema (may be null) - *
                              3. TABLE_NAME String => type name - *
                              4. SUPERTABLE_NAME String => the direct super type's name + *
                              5. TABLE_CAT String {@code =>} the type's catalog (may be null) + *
                              6. TABLE_SCHEM String {@code =>} type's schema (may be null) + *
                              7. TABLE_NAME String {@code =>} type name + *
                              8. SUPERTABLE_NAME String {@code =>} the direct super type's name *
                              * *

                              Note: If the driver does not support type hierarchies, an @@ -3001,35 +3001,35 @@ public interface DatabaseMetaData extends Wrapper { * The ResultSet object that is returned has the following * columns: *

                                - *
                              1. TYPE_CAT String => type catalog (may be null) - *
                              2. TYPE_SCHEM String => type schema (may be null) - *
                              3. TYPE_NAME String => type name - *
                              4. ATTR_NAME String => attribute name - *
                              5. DATA_TYPE int => attribute type SQL type from java.sql.Types - *
                              6. ATTR_TYPE_NAME String => Data source dependent type name. + *
                              7. TYPE_CAT String {@code =>} type catalog (may be null) + *
                              8. TYPE_SCHEM String {@code =>} type schema (may be null) + *
                              9. TYPE_NAME String {@code =>} type name + *
                              10. ATTR_NAME String {@code =>} attribute name + *
                              11. DATA_TYPE int {@code =>} attribute type SQL type from java.sql.Types + *
                              12. ATTR_TYPE_NAME String {@code =>} Data source dependent type name. * For a UDT, the type name is fully qualified. For a REF, the type name is * fully qualified and represents the target type of the reference type. - *
                              13. ATTR_SIZE int => column size. For char or date + *
                              14. ATTR_SIZE int {@code =>} column size. For char or date * types this is the maximum number of characters; for numeric or * decimal types this is precision. - *
                              15. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where + *
                              16. DECIMAL_DIGITS int {@code =>} the number of fractional digits. Null is returned for data types where * DECIMAL_DIGITS is not applicable. - *
                              17. NUM_PREC_RADIX int => Radix (typically either 10 or 2) - *
                              18. NULLABLE int => whether NULL is allowed + *
                              19. NUM_PREC_RADIX int {@code =>} Radix (typically either 10 or 2) + *
                              20. NULLABLE int {@code =>} whether NULL is allowed *
                                  *
                                • attributeNoNulls - might not allow NULL values *
                                • attributeNullable - definitely allows NULL values *
                                • attributeNullableUnknown - nullability unknown *
                                - *
                              21. REMARKS String => comment describing column (may be null) - *
                              22. ATTR_DEF String => default value (may be null) - *
                              23. SQL_DATA_TYPE int => unused - *
                              24. SQL_DATETIME_SUB int => unused - *
                              25. CHAR_OCTET_LENGTH int => for char types the + *
                              26. REMARKS String {@code =>} comment describing column (may be null) + *
                              27. ATTR_DEF String {@code =>} default value (may be null) + *
                              28. SQL_DATA_TYPE int {@code =>} unused + *
                              29. SQL_DATETIME_SUB int {@code =>} unused + *
                              30. CHAR_OCTET_LENGTH int {@code =>} for char types the * maximum number of bytes in the column - *
                              31. ORDINAL_POSITION int => index of the attribute in the UDT + *
                              32. ORDINAL_POSITION int {@code =>} index of the attribute in the UDT * (starting at 1) - *
                              33. IS_NULLABLE String => ISO rules are used to determine + *
                              34. IS_NULLABLE String {@code =>} ISO rules are used to determine * the nullability for a attribute. *
                                  *
                                • YES --- if the attribute can include NULLs @@ -3037,13 +3037,13 @@ public interface DatabaseMetaData extends Wrapper { *
                                • empty string --- if the nullability for the * attribute is unknown *
                                - *
                              35. SCOPE_CATALOG String => catalog of table that is the + *
                              36. SCOPE_CATALOG String {@code =>} catalog of table that is the * scope of a reference attribute (null if DATA_TYPE isn't REF) - *
                              37. SCOPE_SCHEMA String => schema of table that is the + *
                              38. SCOPE_SCHEMA String {@code =>} schema of table that is the * scope of a reference attribute (null if DATA_TYPE isn't REF) - *
                              39. SCOPE_TABLE String => table name that is the scope of a + *
                              40. SCOPE_TABLE String {@code =>} table name that is the scope of a * reference attribute (null if the DATA_TYPE isn't REF) - *
                              41. SOURCE_DATA_TYPE short => source type of a distinct type or user-generated + *
                              42. SOURCE_DATA_TYPE short {@code =>} source type of a distinct type or user-generated * Ref type,SQL type from java.sql.Types (null if DATA_TYPE * isn't DISTINCT or user-generated REF) *
                              @@ -3203,14 +3203,14 @@ public interface DatabaseMetaData extends Wrapper { * and if so the lifetime for which a RowId object remains valid. *

                              * The returned int values have the following relationship: - *

                              +     * 
                              {@code
                                    *     ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION
                                    *         < ROWID_VALID_SESSION < ROWID_VALID_FOREVER
                              -     * 
                              + * }
                              * so conditional logic such as - *
                              +     * 
                              {@code
                                    *     if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)
                              -     * 
                              + * }
                              * can be used. Valid Forever means valid across all Sessions, and valid for * a Session means valid across all its contained Transactions. * @@ -3227,8 +3227,8 @@ public interface DatabaseMetaData extends Wrapper { * *

                              The schema columns are: *

                                - *
                              1. TABLE_SCHEM String => schema name - *
                              2. TABLE_CATALOG String => catalog name (may be null) + *
                              3. TABLE_SCHEM String {@code =>} schema name + *
                              4. TABLE_CATALOG String {@code =>} catalog name (may be null) *
                              * * @@ -3273,10 +3273,10 @@ public interface DatabaseMetaData extends Wrapper { * that the driver supports. The result set contains the following columns *

                              *

                                - *
                              1. NAME String=> The name of the client info property
                                - *
                              2. MAX_LEN int=> The maximum length of the value for the property
                                - *
                              3. DEFAULT_VALUE String=> The default value of the property
                                - *
                              4. DESCRIPTION String=> A description of the property. This will typically + *
                              5. NAME String{@code =>} The name of the client info property
                                + *
                              6. MAX_LEN int{@code =>} The maximum length of the value for the property
                                + *
                              7. DEFAULT_VALUE String{@code =>} The default value of the property
                                + *
                              8. DESCRIPTION String{@code =>} A description of the property. This will typically * contain information as to where this property is * stored in the database. *
                              @@ -3305,19 +3305,19 @@ public interface DatabaseMetaData extends Wrapper { * *

                              Each function description has the the following columns: *

                                - *
                              1. FUNCTION_CAT String => function catalog (may be null) - *
                              2. FUNCTION_SCHEM String => function schema (may be null) - *
                              3. FUNCTION_NAME String => function name. This is the name + *
                              4. FUNCTION_CAT String {@code =>} function catalog (may be null) + *
                              5. FUNCTION_SCHEM String {@code =>} function schema (may be null) + *
                              6. FUNCTION_NAME String {@code =>} function name. This is the name * used to invoke the function - *
                              7. REMARKS String => explanatory comment on the function - *
                              8. FUNCTION_TYPE short => kind of function: + *
                              9. REMARKS String {@code =>} explanatory comment on the function + *
                              10. FUNCTION_TYPE short {@code =>} kind of function: *
                                  *
                                • functionResultUnknown - Cannot determine if a return value * or table will be returned *
                                • functionNoTable- Does not return a table *
                                • functionReturnsTable - Returns a table *
                                - *
                              11. SPECIFIC_NAME String => the name which uniquely identifies + *
                              12. SPECIFIC_NAME String {@code =>} the name which uniquely identifies * this function within its schema. This is a user specified, or DBMS * generated, name that may be different then the FUNCTION_NAME * for example with overload functions @@ -3359,12 +3359,12 @@ public interface DatabaseMetaData extends Wrapper { * is a parameter description, column description or * return type description with the following fields: *
                                  - *
                                1. FUNCTION_CAT String => function catalog (may be null) - *
                                2. FUNCTION_SCHEM String => function schema (may be null) - *
                                3. FUNCTION_NAME String => function name. This is the name + *
                                4. FUNCTION_CAT String {@code =>} function catalog (may be null) + *
                                5. FUNCTION_SCHEM String {@code =>} function schema (may be null) + *
                                6. FUNCTION_NAME String {@code =>} function name. This is the name * used to invoke the function - *
                                7. COLUMN_NAME String => column/parameter name - *
                                8. COLUMN_TYPE Short => kind of column/parameter: + *
                                9. COLUMN_NAME String {@code =>} column/parameter name + *
                                10. COLUMN_TYPE Short {@code =>} kind of column/parameter: *
                                    *
                                  • functionColumnUnknown - nobody knows *
                                  • functionColumnIn - IN parameter @@ -3374,30 +3374,30 @@ public interface DatabaseMetaData extends Wrapper { *
                                  • functionColumnResult - Indicates that the parameter or column * is a column in the ResultSet *
                                  - *
                                11. DATA_TYPE int => SQL type from java.sql.Types - *
                                12. TYPE_NAME String => SQL type name, for a UDT type the + *
                                13. DATA_TYPE int {@code =>} SQL type from java.sql.Types + *
                                14. TYPE_NAME String {@code =>} SQL type name, for a UDT type the * type name is fully qualified - *
                                15. PRECISION int => precision - *
                                16. LENGTH int => length in bytes of data - *
                                17. SCALE short => scale - null is returned for data types where + *
                                18. PRECISION int {@code =>} precision + *
                                19. LENGTH int {@code =>} length in bytes of data + *
                                20. SCALE short {@code =>} scale - null is returned for data types where * SCALE is not applicable. - *
                                21. RADIX short => radix - *
                                22. NULLABLE short => can it contain NULL. + *
                                23. RADIX short {@code =>} radix + *
                                24. NULLABLE short {@code =>} can it contain NULL. *
                                    *
                                  • functionNoNulls - does not allow NULL values *
                                  • functionNullable - allows NULL values *
                                  • functionNullableUnknown - nullability unknown *
                                  - *
                                25. REMARKS String => comment describing column/parameter - *
                                26. CHAR_OCTET_LENGTH int => the maximum length of binary + *
                                27. REMARKS String {@code =>} comment describing column/parameter + *
                                28. CHAR_OCTET_LENGTH int {@code =>} the maximum length of binary * and character based parameters or columns. For any other datatype the returned value * is a NULL - *
                                29. ORDINAL_POSITION int => the ordinal position, starting + *
                                30. ORDINAL_POSITION int {@code =>} the ordinal position, starting * from 1, for the input and output parameters. A value of 0 * is returned if this row describes the function's return value. * For result set columns, it is the * ordinal position of the column in the result set starting from 1. - *
                                31. IS_NULLABLE String => ISO rules are used to determine + *
                                32. IS_NULLABLE String {@code =>} ISO rules are used to determine * the nullability for a parameter or column. *
                                    *
                                  • YES --- if the parameter or column can include NULLs @@ -3405,7 +3405,7 @@ public interface DatabaseMetaData extends Wrapper { *
                                  • empty string --- if the nullability for the * parameter or column is unknown *
                                  - *
                                33. SPECIFIC_NAME String => the name which uniquely identifies + *
                                34. SPECIFIC_NAME String {@code =>} the name which uniquely identifies * this function within its schema. This is a user specified, or DBMS * generated, name that may be different then the FUNCTION_NAME * for example with overload functions @@ -3591,21 +3591,21 @@ public interface DatabaseMetaData extends Wrapper { * *

                                  Each column description has the following columns: *

                                    - *
                                  1. TABLE_CAT String => table catalog (may be null) - *
                                  2. TABLE_SCHEM String => table schema (may be null) - *
                                  3. TABLE_NAME String => table name - *
                                  4. COLUMN_NAME String => column name - *
                                  5. DATA_TYPE int => SQL type from java.sql.Types - *
                                  6. COLUMN_SIZE int => column size. - *
                                  7. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where + *
                                  8. TABLE_CAT String {@code =>} table catalog (may be null) + *
                                  9. TABLE_SCHEM String {@code =>} table schema (may be null) + *
                                  10. TABLE_NAME String {@code =>} table name + *
                                  11. COLUMN_NAME String {@code =>} column name + *
                                  12. DATA_TYPE int {@code =>} SQL type from java.sql.Types + *
                                  13. COLUMN_SIZE int {@code =>} column size. + *
                                  14. DECIMAL_DIGITS int {@code =>} the number of fractional digits. Null is returned for data types where * DECIMAL_DIGITS is not applicable. - *
                                  15. NUM_PREC_RADIX int => Radix (typically either 10 or 2) - *
                                  16. COLUMN_USAGE String => The allowed usage for the column. The + *
                                  17. NUM_PREC_RADIX int {@code =>} Radix (typically either 10 or 2) + *
                                  18. COLUMN_USAGE String {@code =>} The allowed usage for the column. The * value returned will correspond to the enum name returned by {@link PseudoColumnUsage#name PseudoColumnUsage.name()} - *
                                  19. REMARKS String => comment describing column (may be null) - *
                                  20. CHAR_OCTET_LENGTH int => for char types the + *
                                  21. REMARKS String {@code =>} comment describing column (may be null) + *
                                  22. CHAR_OCTET_LENGTH int {@code =>} for char types the * maximum number of bytes in the column - *
                                  23. IS_NULLABLE String => ISO rules are used to determine the nullability for a column. + *
                                  24. IS_NULLABLE String {@code =>} ISO rules are used to determine the nullability for a column. *
                                      *
                                    • YES --- if the column can include NULLs *
                                    • NO --- if the column cannot include NULLs diff --git a/src/share/classes/java/sql/DriverManager.java b/src/share/classes/java/sql/DriverManager.java index fbe163635..797a920d2 100644 --- a/src/share/classes/java/sql/DriverManager.java +++ b/src/share/classes/java/sql/DriverManager.java @@ -36,7 +36,7 @@ import sun.reflect.Reflection; /** *

                                      The basic service for managing a set of JDBC drivers.
                                      - * NOTE: The {@link DataSource} interface, new in the + * NOTE: The {@link javax.sql.DataSource} interface, new in the * JDBC 2.0 API, provides another way to connect to a data source. * The use of a DataSource object is the preferred means of * connecting to a data source. diff --git a/src/share/classes/java/sql/ResultSet.java b/src/share/classes/java/sql/ResultSet.java index ab5477331..7029c9359 100644 --- a/src/share/classes/java/sql/ResultSet.java +++ b/src/share/classes/java/sql/ResultSet.java @@ -1350,7 +1350,7 @@ public interface ResultSet extends Wrapper, AutoCloseable { * @param rows the number of rows to fetch * @exception SQLException if a database access error occurs; this method * is called on a closed result set or the - * condition rows >= 0 is not satisfied + * condition {@code rows >= 0} is not satisfied * @since 1.2 * @see #getFetchSize */ diff --git a/src/share/classes/java/sql/Statement.java b/src/share/classes/java/sql/Statement.java index 34859c52c..29b372f52 100644 --- a/src/share/classes/java/sql/Statement.java +++ b/src/share/classes/java/sql/Statement.java @@ -144,7 +144,7 @@ public interface Statement extends Wrapper, AutoCloseable { * @param max the new column size limit in bytes; zero means there is no limit * @exception SQLException if a database access error occurs, * this method is called on a closed Statement - * or the condition max >= 0 is not satisfied + * or the condition {@code max >= 0} is not satisfied * @see #getMaxFieldSize */ void setMaxFieldSize(int max) throws SQLException; @@ -174,7 +174,7 @@ public interface Statement extends Wrapper, AutoCloseable { * @param max the new max rows limit; zero means there is no limit * @exception SQLException if a database access error occurs, * this method is called on a closed Statement - * or the condition max >= 0 is not satisfied + * or the condition {@code max >= 0} is not satisfied * @see #getMaxRows */ void setMaxRows(int max) throws SQLException; @@ -240,7 +240,7 @@ public interface Statement extends Wrapper, AutoCloseable { * there is no limit * @exception SQLException if a database access error occurs, * this method is called on a closed Statement - * or the condition seconds >= 0 is not satisfied + * or the condition {@code seconds >= 0} is not satisfied * @see #getQueryTimeout */ void setQueryTimeout(int seconds) throws SQLException; @@ -385,10 +385,10 @@ public interface Statement extends Wrapper, AutoCloseable { * object(s) obtained with the method getResultSet. * *

                                      There are no more results when the following is true: - *

                                      +     * 
                                      {@code
                                            *     // stmt is a Statement object
                                            *     ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
                                      -     * 
                                      + * }
                                      * * @return true if the next result is a ResultSet * object; false if it is an update count or there are @@ -452,7 +452,7 @@ public interface Statement extends Wrapper, AutoCloseable { * @param rows the number of rows to fetch * @exception SQLException if a database access error occurs, * this method is called on a closed Statement or the - * condition rows >= 0 is not satisfied. + * condition {@code rows >= 0} is not satisfied. * @since 1.2 * @see #getFetchSize */ @@ -665,10 +665,10 @@ public interface Statement extends Wrapper, AutoCloseable { * true if the next result is a ResultSet object. * *

                                      There are no more results when the following is true: - *

                                      +     * 
                                      {@code
                                            *     // stmt is a Statement object
                                            *     ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
                                      -     * 
                                      + * }
                                      * * @param current one of the following Statement * constants indicating what should happen to current @@ -1107,7 +1107,7 @@ public interface Statement extends Wrapper, AutoCloseable { * @param max the new max rows limit; zero means there is no limit * @exception SQLException if a database access error occurs, * this method is called on a closed Statement - * or the condition max >= 0 is not satisfied + * or the condition {@code max >= 0} is not satisfied * @see #getMaxRows * @since 1.8 */ diff --git a/src/share/classes/java/text/CharacterIterator.java b/src/share/classes/java/text/CharacterIterator.java index 2b21e14e5..7674268db 100644 --- a/src/share/classes/java/text/CharacterIterator.java +++ b/src/share/classes/java/text/CharacterIterator.java @@ -62,27 +62,27 @@ package java.text; *

                                      Examples:

                                      * * Traverse the text from start to finish - *

                                      + * 
                                      {@code
                                        * public void traverseForward(CharacterIterator iter) {
                                        *     for(char c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
                                        *         processChar(c);
                                        *     }
                                        * }
                                      - * 
                                      + * }
                                      * * Traverse the text backwards, from end to start - *
                                      + * 
                                      {@code
                                        * public void traverseBackward(CharacterIterator iter) {
                                        *     for(char c = iter.last(); c != CharacterIterator.DONE; c = iter.previous()) {
                                        *         processChar(c);
                                        *     }
                                        * }
                                      - * 
                                      + * }
                                      * * Traverse both forward and backward from a given position in the text. * Calls to notBoundary() in this example represents some * additional stopping criteria. - *
                                      + * 
                                      {@code
                                        * public void traverseOut(CharacterIterator iter, int pos) {
                                        *     for (char c = iter.setIndex(pos);
                                        *              c != CharacterIterator.DONE && notBoundary(c);
                                      @@ -96,7 +96,7 @@ package java.text;
                                        *     int start = iter.getIndex();
                                        *     processSection(start, end);
                                        * }
                                      - * 
                                      + * }
                                      * * @see StringCharacterIterator * @see AttributedCharacterIterator diff --git a/src/share/classes/java/text/ChoiceFormat.java b/src/share/classes/java/text/ChoiceFormat.java index 1e3188483..7814f0ef2 100644 --- a/src/share/classes/java/text/ChoiceFormat.java +++ b/src/share/classes/java/text/ChoiceFormat.java @@ -376,7 +376,7 @@ public class ChoiceFormat extends NumberFormat { /** * Returns pattern with formatted double. - * @param number number to be formatted & substituted. + * @param number number to be formatted and substituted. * @param toAppendTo where text is appended. * @param status ignore no useful status is returned. */ diff --git a/src/share/classes/java/text/Collator.java b/src/share/classes/java/text/Collator.java index aaa5276d6..d105a8104 100644 --- a/src/share/classes/java/text/Collator.java +++ b/src/share/classes/java/text/Collator.java @@ -72,14 +72,14 @@ import sun.util.locale.provider.LocaleServiceProviderPool; * The following example shows how to compare two strings using * the Collator for the default locale. *
                                      - *
                                      + * 
                                      {@code
                                        * // Compare two strings in the default locale
                                        * Collator myCollator = Collator.getInstance();
                                        * if( myCollator.compare("abc", "ABC") < 0 )
                                        *     System.out.println("abc is less than ABC");
                                        * else
                                        *     System.out.println("abc is greater than or equal to ABC");
                                      - * 
                                      + * }
                                      *
                                      * *

                                      diff --git a/src/share/classes/java/util/Calendar.java b/src/share/classes/java/util/Calendar.java index 19c3c8540..566b8b090 100644 --- a/src/share/classes/java/util/Calendar.java +++ b/src/share/classes/java/util/Calendar.java @@ -2681,9 +2681,9 @@ public abstract class Calendar implements Serializable, Cloneable, ComparableCalendar represents a time * before the time represented by the specified * Object. This method is equivalent to: - *

                                      + *
                                      {@code
                                            *         compareTo(when) < 0
                                      -     * 
                                      + * } * if and only if when is a Calendar * instance. Otherwise, the method returns false. * @@ -2702,9 +2702,9 @@ public abstract class Calendar implements Serializable, Cloneable, ComparableCalendar represents a time * after the time represented by the specified * Object. This method is equivalent to: - *
                                      + *
                                      {@code
                                            *         compareTo(when) > 0
                                      -     * 
                                      + * } * if and only if when is a Calendar * instance. Otherwise, the method returns false. * diff --git a/src/share/classes/java/util/Collections.java b/src/share/classes/java/util/Collections.java index 30d589cdc..da258793b 100644 --- a/src/share/classes/java/util/Collections.java +++ b/src/share/classes/java/util/Collections.java @@ -924,9 +924,9 @@ public class Collections { * Returns the starting position of the first occurrence of the specified * target list within the specified source list, or -1 if there is no * such occurrence. More formally, returns the lowest index i - * such that source.subList(i, i+target.size()).equals(target), + * such that {@code source.subList(i, i+target.size()).equals(target)}, * or -1 if there is no such index. (Returns -1 if - * target.size() > source.size().) + * {@code target.size() > source.size()}) * *

                                      This implementation uses the "brute force" technique of scanning * over the source list, looking for a match with the target at each @@ -977,9 +977,9 @@ public class Collections { * Returns the starting position of the last occurrence of the specified * target list within the specified source list, or -1 if there is no such * occurrence. More formally, returns the highest index i - * such that source.subList(i, i+target.size()).equals(target), + * such that {@code source.subList(i, i+target.size()).equals(target)}, * or -1 if there is no such index. (Returns -1 if - * target.size() > source.size().) + * {@code target.size() > source.size()}) * *

                                      This implementation uses the "brute force" technique of iterating * over the source list, looking for a match with the target at each diff --git a/src/share/classes/java/util/Date.java b/src/share/classes/java/util/Date.java index 61dac3503..502daaefd 100644 --- a/src/share/classes/java/util/Date.java +++ b/src/share/classes/java/util/Date.java @@ -984,8 +984,9 @@ public class Date * exclusive OR of the two halves of the primitive long * value returned by the {@link Date#getTime} * method. That is, the hash code is the value of the expression: - *

                                      -     * (int)(this.getTime()^(this.getTime() >>> 32))
                                      + *
                                      {@code
                                      +     * (int)(this.getTime()^(this.getTime() >>> 32))
                                      +     * }
                                      * * @return a hash code value for this object. */ @@ -1085,7 +1086,7 @@ public class Date /** * Creates a string representation of this Date object of * the form: - * + *
                                            * d mon yyyy hh:mm:ss GMT
                                      * where:
                                        *
                                      • d is the day of the month (1 through 31), diff --git a/src/share/classes/java/util/LinkedHashMap.java b/src/share/classes/java/util/LinkedHashMap.java index 100710b1b..59a8d8f1a 100644 --- a/src/share/classes/java/util/LinkedHashMap.java +++ b/src/share/classes/java/util/LinkedHashMap.java @@ -437,13 +437,13 @@ public class LinkedHashMap *

                                        Sample use: this override will allow the map to grow up to 100 * entries and then delete the eldest entry each time a new entry is * added, maintaining a steady state of 100 entries. - *

                                        +     * 
                                        {@code
                                              *     private static final int MAX_ENTRIES = 100;
                                              *
                                              *     protected boolean removeEldestEntry(Map.Entry eldest) {
                                              *        return size() > MAX_ENTRIES;
                                              *     }
                                        -     * 
                                        + * }
                                        * *

                                        This method typically does not modify the map in any way, * instead allowing the map to modify itself as directed by its diff --git a/src/share/classes/java/util/Random.java b/src/share/classes/java/util/Random.java index c169e053d..ca430bae2 100644 --- a/src/share/classes/java/util/Random.java +++ b/src/share/classes/java/util/Random.java @@ -372,7 +372,7 @@ class Random implements java.io.Serializable { * range {@code 0.0f} (inclusive) to {@code 1.0f} (exclusive), is * pseudorandomly generated and returned. All 224 possible {@code float} values - * of the form m x 2m x 2-24, where m is a positive * integer less than 224 , are * produced with (approximately) equal probability. diff --git a/src/share/classes/java/util/ResourceBundle.java b/src/share/classes/java/util/ResourceBundle.java index 0d52daa9c..1d9d80b90 100644 --- a/src/share/classes/java/util/ResourceBundle.java +++ b/src/share/classes/java/util/ResourceBundle.java @@ -2323,9 +2323,9 @@ public abstract class ResourceBundle { * is returned. And if the resource bundles for the "ja" and * "" Locales are found, then the runtime resource * lookup path (parent chain) is: - *

                                        +         * 
                                        {@code
                                                  *     Messages_ja -> Messages
                                        -         * 
                                        + * }
                                        * * @param baseName * the base name of the resource bundle, a fully diff --git a/src/share/classes/java/util/Scanner.java b/src/share/classes/java/util/Scanner.java index cc19b0d12..f6967f3a7 100644 --- a/src/share/classes/java/util/Scanner.java +++ b/src/share/classes/java/util/Scanner.java @@ -49,47 +49,51 @@ import sun.misc.LRUCache; * *

                                        For example, this code allows a user to read a number from * System.in: - *

                                        + * 
                                        {@code
                                          *     Scanner sc = new Scanner(System.in);
                                          *     int i = sc.nextInt();
                                        - * 
                                        + * }
                                        * *

                                        As another example, this code allows long types to be * assigned from entries in a file myNumbers: - *

                                        + * 
                                        {@code
                                          *      Scanner sc = new Scanner(new File("myNumbers"));
                                          *      while (sc.hasNextLong()) {
                                          *          long aLong = sc.nextLong();
                                        - *      }
                                        + * } + * }
                                        * *

                                        The scanner can also use delimiters other than whitespace. This * example reads several items in from a string: - *

                                        + * 
                                        {@code
                                          *     String input = "1 fish 2 fish red fish blue fish";
                                          *     Scanner s = new Scanner(input).useDelimiter("\\s*fish\\s*");
                                          *     System.out.println(s.nextInt());
                                          *     System.out.println(s.nextInt());
                                          *     System.out.println(s.next());
                                          *     System.out.println(s.next());
                                        - *     s.close(); 
                                        + * s.close(); + * }
                                        *

                                        * prints the following output: - *

                                        + * 
                                        {@code
                                          *     1
                                          *     2
                                          *     red
                                        - *     blue 
                                        + * blue + * }
* *

The same output can be generated with this code, which uses a regular * expression to parse all four tokens at once: - *

+ * 
{@code
  *     String input = "1 fish 2 fish red fish blue fish";
  *     Scanner s = new Scanner(input);
  *     s.findInLine("(\\d+) fish (\\d+) fish (\\w+) fish (\\w+)");
  *     MatchResult result = s.match();
  *     for (int i=1; i<=result.groupCount(); i++)
  *         System.out.println(result.group(i));
- *     s.close(); 
+ * s.close(); + * }
* *

The default whitespace delimiter used * by a scanner is as recognized by {@link java.lang.Character}.{@link @@ -2640,11 +2644,11 @@ public final class Scanner implements Iterator, Closeable { * scanner.reset() behaves in exactly the same way as the * invocation * - *

+     * 
{@code
      *   scanner.useDelimiter("\\p{javaWhitespace}+")
      *          .useLocale(Locale.getDefault(Locale.Category.FORMAT))
      *          .useRadix(10);
-     * 
+ * }
* * @return this scanner * diff --git a/src/share/classes/java/util/TimerTask.java b/src/share/classes/java/util/TimerTask.java index b8c834086..691c9a03d 100644 --- a/src/share/classes/java/util/TimerTask.java +++ b/src/share/classes/java/util/TimerTask.java @@ -130,14 +130,14 @@ public abstract class TimerTask implements Runnable { *

This method is typically invoked from within a task's run method, to * determine whether the current execution of the task is sufficiently * timely to warrant performing the scheduled activity: - *

+     * 
{@code
      *   public void run() {
      *       if (System.currentTimeMillis() - scheduledExecutionTime() >=
      *           MAX_TARDINESS)
      *               return;  // Too late; skip this execution.
      *       // Perform the task
      *   }
-     * 
+ * }
* This method is typically not used in conjunction with * fixed-delay execution repeating tasks, as their scheduled * execution times are allowed to drift over time, and so are not terribly diff --git a/src/share/classes/java/util/jar/Pack200.java b/src/share/classes/java/util/jar/Pack200.java index c3ea39587..dbefe5930 100644 --- a/src/share/classes/java/util/jar/Pack200.java +++ b/src/share/classes/java/util/jar/Pack200.java @@ -45,7 +45,7 @@ import java.beans.PropertyChangeListener; * transform the byte-stream back to JAR format. *

* Here is an example using packer and unpacker:

- *

+ * 
{@code
  *    import java.util.jar.Pack200;
  *    import java.util.jar.Pack200.*;
  *    ...
@@ -90,7 +90,7 @@ import java.beans.PropertyChangeListener;
  *    } catch (IOException ioe) {
  *        ioe.printStackTrace();
  *    }
- * 
+ * } *

* A Pack200 file compressed with gzip can be hosted on HTTP/1.1 web servers. * The deployment applications can use "Accept-Encoding=pack200-gzip". This diff --git a/src/share/classes/java/util/logging/ConsoleHandler.java b/src/share/classes/java/util/logging/ConsoleHandler.java index e0e70a5e6..a8b4bc4f0 100644 --- a/src/share/classes/java/util/logging/ConsoleHandler.java +++ b/src/share/classes/java/util/logging/ConsoleHandler.java @@ -35,7 +35,7 @@ import java.net.*; *

* Configuration: * By default each ConsoleHandler is initialized using the following - * LogManager configuration properties where + * LogManager configuration properties where {@code } * refers to the fully-qualified class name of the handler. * If properties are not defined * (or have invalid values) then the specified default values are used. diff --git a/src/share/classes/java/util/logging/FileHandler.java b/src/share/classes/java/util/logging/FileHandler.java index 8d3b28d8d..52360c206 100644 --- a/src/share/classes/java/util/logging/FileHandler.java +++ b/src/share/classes/java/util/logging/FileHandler.java @@ -333,7 +333,7 @@ public class FileHandler extends StreamHandler { * @exception IOException if there are IO problems opening the files. * @exception SecurityException if a security manager exists and if * the caller does not have LoggingPermission("control"). - * @exception IllegalArgumentException if limit < 0, or count < 1. + * @exception IllegalArgumentException if {@code limit < 0}, or {@code count < 1}. * @exception IllegalArgumentException if pattern is an empty string */ public FileHandler(String pattern, int limit, int count) @@ -371,7 +371,7 @@ public class FileHandler extends StreamHandler { * @exception IOException if there are IO problems opening the files. * @exception SecurityException if a security manager exists and if * the caller does not have LoggingPermission("control"). - * @exception IllegalArgumentException if limit < 0, or count < 1. + * @exception IllegalArgumentException if {@code limit < 0}, or {@code count < 1}. * @exception IllegalArgumentException if pattern is an empty string * */ diff --git a/src/share/classes/java/util/logging/MemoryHandler.java b/src/share/classes/java/util/logging/MemoryHandler.java index 5c545cc29..ddf72c2a1 100644 --- a/src/share/classes/java/util/logging/MemoryHandler.java +++ b/src/share/classes/java/util/logging/MemoryHandler.java @@ -64,7 +64,7 @@ package java.util.logging; * (defaults to no Filter). *

  • <handler-name>.size * defines the buffer size (defaults to 1000).
  • - *
  • <handler-name>.push + *
  • <handler-name>.push * defines the pushLevel (defaults to level.SEVERE).
  • *
  • <handler-name>.target * specifies the name of the target Handler class. @@ -155,7 +155,7 @@ public class MemoryHandler extends Handler { * @param size the number of log records to buffer (must be greater than zero) * @param pushLevel message level to push on * - * @throws IllegalArgumentException if size is <= 0 + * @throws IllegalArgumentException if {@code size is <= 0} */ public MemoryHandler(Handler target, int size, Level pushLevel) { if (target == null || pushLevel == null) { diff --git a/src/share/classes/java/util/prefs/Preferences.java b/src/share/classes/java/util/prefs/Preferences.java index 1867fca91..e3f459290 100644 --- a/src/share/classes/java/util/prefs/Preferences.java +++ b/src/share/classes/java/util/prefs/Preferences.java @@ -134,52 +134,52 @@ import java.lang.Double; * subsequently restore from the backup. * *

    The XML document has the following DOCTYPE declaration: - *

    - * <!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
    - * 
    + *
    {@code
    + * 
    + * }
    * Note that the system URI (http://java.sun.com/dtd/preferences.dtd) is * not accessed when exporting or importing preferences; it merely * serves as a string to uniquely identify the DTD, which is: - *
    - *    <?xml version="1.0" encoding="UTF-8"?>
    + * 
    {@code
    + *    
      *
    - *    <!-- DTD for a Preferences tree. -->
    + *    
      *
    - *    <!-- The preferences element is at the root of an XML document
    - *         representing a Preferences tree. -->
    - *    <!ELEMENT preferences (root)>
    + *    
    + *    
      *
    - *    <!-- The preferences element contains an optional version attribute,
    - *          which specifies version of DTD. -->
    - *    <!ATTLIST preferences EXTERNAL_XML_VERSION CDATA "0.0" >
    + *    
    + *    
      *
    - *    <!-- The root element has a map representing the root's preferences
    - *         (if any), and one node for each child of the root (if any). -->
    - *    <!ELEMENT root (map, node*) >
    + *    
    + *    
      *
    - *    <!-- Additionally, the root contains a type attribute, which
    - *         specifies whether it's the system or user root. -->
    - *    <!ATTLIST root
    - *              type (system|user) #REQUIRED >
    + *    
    + *    
      *
    - *    <!-- Each node has a map representing its preferences (if any),
    - *         and one node for each child (if any). -->
    - *    <!ELEMENT node (map, node*) >
    + *    
    + *    
      *
    - *    <!-- Additionally, each node has a name attribute -->
    - *    <!ATTLIST node
    - *              name CDATA #REQUIRED >
    + *    
    + *    
      *
    - *    <!-- A map represents the preferences stored at a node (if any). -->
    - *    <!ELEMENT map (entry*) >
    + *    
    + *    
      *
    - *    <!-- An entry represents a single preference, which is simply
    - *          a key-value pair. -->
    - *    <!ELEMENT entry EMPTY >
    - *    <!ATTLIST entry
    + *    
    + *    
    + *    
    + *              value CDATA #REQUIRED >
    + * }
    * * Every Preferences implementation must have an associated {@link * PreferencesFactory} implementation. Every Java(TM) SE implementation must provide @@ -1161,9 +1161,9 @@ public abstract class Preferences { * This XML document is, in effect, an offline backup of the node. * *

    The XML document will have the following DOCTYPE declaration: - *

    -     * <!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
    -     * 
    + *
    {@code
    +     * 
    +     * }
    * The UTF-8 character encoding will be used. * *

    This method is an exception to the general rule that the results of @@ -1192,9 +1192,9 @@ public abstract class Preferences { * effect, an offline backup of the subtree rooted at the node. * *

    The XML document will have the following DOCTYPE declaration: - *

    -     * <!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
    -     * 
    + *
    {@code
    +     * 
    +     * }
    * The UTF-8 character encoding will be used. * *

    This method is an exception to the general rule that the results of @@ -1228,9 +1228,9 @@ public abstract class Preferences { * do not exist, the nodes will be created. * *

    The XML document must have the following DOCTYPE declaration: - *

    -     * <!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
    -     * 
    + *
    {@code
    +     * 
    +     * }
    * (This method is designed for use in conjunction with * {@link #exportNode(OutputStream)} and * {@link #exportSubtree(OutputStream)}. diff --git a/src/share/classes/java/util/regex/MatchResult.java b/src/share/classes/java/util/regex/MatchResult.java index 9b5233180..9767d2863 100644 --- a/src/share/classes/java/util/regex/MatchResult.java +++ b/src/share/classes/java/util/regex/MatchResult.java @@ -79,7 +79,7 @@ public interface MatchResult { /** * Returns the offset after the last character matched.

    * - * @return @return The offset after the last character matched + * @return The offset after the last character matched * * @throws IllegalStateException * If no match has yet been attempted, diff --git a/src/share/classes/java/util/regex/Pattern.java b/src/share/classes/java/util/regex/Pattern.java index 14cde68c5..ae7468758 100644 --- a/src/share/classes/java/util/regex/Pattern.java +++ b/src/share/classes/java/util/regex/Pattern.java @@ -108,7 +108,7 @@ import java.util.stream.StreamSupport; * \x{h...h} * The character with hexadecimal value 0xh...h * ({@link java.lang.Character#MIN_CODE_POINT Character.MIN_CODE_POINT} - *  <= 0xh...h <=  + *  <= 0xh...h <=  * {@link java.lang.Character#MAX_CODE_POINT Character.MAX_CODE_POINT}) * \t * The tab character ('\u0009') diff --git a/src/share/classes/java/util/stream/package-info.java b/src/share/classes/java/util/stream/package-info.java index 4dfb1e998..39509ffff 100644 --- a/src/share/classes/java/util/stream/package-info.java +++ b/src/share/classes/java/util/stream/package-info.java @@ -141,7 +141,7 @@ * parallelism is explicitly requested. For example, {@code Collection} has methods * {@link java.util.Collection#stream} and {@link java.util.Collection#parallelStream}, * which produce sequential and parallel streams respectively; other stream-bearing methods - * such as {@link java.util.stream.Streams#intRange(int, int)} produce sequential + * such as {@link java.util.stream.IntStream#range(int, int)} produce sequential * streams but these can be efficiently parallelized by calling {@code parallel()} on the * result. The set of operations on serial and parallel streams is identical. To execute the * "sum of weights of blocks" query in parallel, we would do: diff --git a/src/share/classes/java/util/zip/DeflaterInputStream.java b/src/share/classes/java/util/zip/DeflaterInputStream.java index a996b14e0..cdca7f63b 100644 --- a/src/share/classes/java/util/zip/DeflaterInputStream.java +++ b/src/share/classes/java/util/zip/DeflaterInputStream.java @@ -97,7 +97,7 @@ public class DeflaterInputStream extends FilterInputStream { * @param in input stream to read the uncompressed data to * @param defl compressor ("deflater") for this stream * @param bufLen compression buffer size - * @throws IllegalArgumentException if {@code bufLen} is <= 0 + * @throws IllegalArgumentException if {@code bufLen <= 0} * @throws NullPointerException if {@code in} or {@code defl} is null */ public DeflaterInputStream(InputStream in, Deflater defl, int bufLen) { @@ -163,8 +163,7 @@ public class DeflaterInputStream extends FilterInputStream { * @param len maximum number of compressed bytes to read into {@code b} * @return the actual number of bytes read, or -1 if the end of the * uncompressed input stream is reached - * @throws IndexOutOfBoundsException if {@code len} > {@code b.length - - * off} + * @throws IndexOutOfBoundsException if {@code len > b.length - off} * @throws IOException if an I/O error occurs or if this input stream is * already closed */ diff --git a/src/share/classes/java/util/zip/DeflaterOutputStream.java b/src/share/classes/java/util/zip/DeflaterOutputStream.java index c19a222e5..7cb0f8388 100644 --- a/src/share/classes/java/util/zip/DeflaterOutputStream.java +++ b/src/share/classes/java/util/zip/DeflaterOutputStream.java @@ -71,7 +71,7 @@ class DeflaterOutputStream extends FilterOutputStream { * {@link Deflater#SYNC_FLUSH} before flushing the output * stream, otherwise only flushes the output stream * - * @throws IllegalArgumentException if size is <= 0 + * @throws IllegalArgumentException if {@code size <= 0} * * @since 1.7 */ @@ -101,7 +101,7 @@ class DeflaterOutputStream extends FilterOutputStream { * @param out the output stream * @param def the compressor ("deflater") * @param size the output buffer size - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} */ public DeflaterOutputStream(OutputStream out, Deflater def, int size) { this(out, def, size, false); diff --git a/src/share/classes/java/util/zip/GZIPInputStream.java b/src/share/classes/java/util/zip/GZIPInputStream.java index 74a5c60f1..b3d9240ba 100644 --- a/src/share/classes/java/util/zip/GZIPInputStream.java +++ b/src/share/classes/java/util/zip/GZIPInputStream.java @@ -71,7 +71,7 @@ class GZIPInputStream extends InflaterInputStream { * @exception ZipException if a GZIP format error has occurred or the * compression method used is unsupported * @exception IOException if an I/O error has occurred - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} */ public GZIPInputStream(InputStream in, int size) throws IOException { super(in, new Inflater(true), size); diff --git a/src/share/classes/java/util/zip/GZIPOutputStream.java b/src/share/classes/java/util/zip/GZIPOutputStream.java index d5edcf122..e454956a1 100644 --- a/src/share/classes/java/util/zip/GZIPOutputStream.java +++ b/src/share/classes/java/util/zip/GZIPOutputStream.java @@ -61,8 +61,7 @@ class GZIPOutputStream extends DeflaterOutputStream { * @param out the output stream * @param size the output buffer size * @exception IOException If an I/O error has occurred. - * @exception IllegalArgumentException if size is <= 0 - + * @exception IllegalArgumentException if {@code size <= 0} */ public GZIPOutputStream(OutputStream out, int size) throws IOException { this(out, size, false); @@ -81,7 +80,7 @@ class GZIPOutputStream extends DeflaterOutputStream { * {@link Deflater#SYNC_FLUSH} before flushing the output * stream, otherwise only flushes the output stream * @exception IOException If an I/O error has occurred. - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} * * @since 1.7 */ diff --git a/src/share/classes/java/util/zip/InflaterInputStream.java b/src/share/classes/java/util/zip/InflaterInputStream.java index b948905d0..23cb9d943 100644 --- a/src/share/classes/java/util/zip/InflaterInputStream.java +++ b/src/share/classes/java/util/zip/InflaterInputStream.java @@ -75,7 +75,7 @@ class InflaterInputStream extends FilterInputStream { * @param in the input stream * @param inf the decompressor ("inflater") * @param size the input buffer size - * @exception IllegalArgumentException if size is <= 0 + * @exception IllegalArgumentException if {@code size <= 0} */ public InflaterInputStream(InputStream in, Inflater inf, int size) { super(in); @@ -191,7 +191,7 @@ class InflaterInputStream extends FilterInputStream { * @param n the number of bytes to skip * @return the actual number of bytes skipped. * @exception IOException if an I/O error has occurred - * @exception IllegalArgumentException if n < 0 + * @exception IllegalArgumentException if {@code n < 0} */ public long skip(long n) throws IOException { if (n < 0) { diff --git a/src/share/classes/java/util/zip/InflaterOutputStream.java b/src/share/classes/java/util/zip/InflaterOutputStream.java index ab90ccb03..53f8b5ded 100644 --- a/src/share/classes/java/util/zip/InflaterOutputStream.java +++ b/src/share/classes/java/util/zip/InflaterOutputStream.java @@ -97,7 +97,7 @@ public class InflaterOutputStream extends FilterOutputStream { * @param out output stream to write the uncompressed data to * @param infl decompressor ("inflater") for this stream * @param bufLen decompression buffer size - * @throws IllegalArgumentException if {@code bufLen} is <= 0 + * @throws IllegalArgumentException if {@code bufLen <= 0} * @throws NullPointerException if {@code out} or {@code infl} is null */ public InflaterOutputStream(OutputStream out, Inflater infl, int bufLen) { @@ -211,8 +211,8 @@ public class InflaterOutputStream extends FilterOutputStream { * the output stream * @param off starting offset of the compressed data within {@code b} * @param len number of bytes to decompress from {@code b} - * @throws IndexOutOfBoundsException if {@code off} < 0, or if - * {@code len} < 0, or if {@code len} > {@code b.length - off} + * @throws IndexOutOfBoundsException if {@code off < 0}, or if + * {@code len < 0}, or if {@code len > b.length - off} * @throws IOException if an I/O error occurs or this stream is already * closed * @throws NullPointerException if {@code b} is null diff --git a/src/share/classes/java/util/zip/ZipInputStream.java b/src/share/classes/java/util/zip/ZipInputStream.java index 5c315d452..fee9f5108 100644 --- a/src/share/classes/java/util/zip/ZipInputStream.java +++ b/src/share/classes/java/util/zip/ZipInputStream.java @@ -232,7 +232,7 @@ class ZipInputStream extends InflaterInputStream implements ZipConstants { * @return the actual number of bytes skipped * @exception ZipException if a ZIP file error has occurred * @exception IOException if an I/O error has occurred - * @exception IllegalArgumentException if n < 0 + * @exception IllegalArgumentException if {@code n < 0} */ public long skip(long n) throws IOException { if (n < 0) { diff --git a/src/share/classes/javax/crypto/spec/IvParameterSpec.java b/src/share/classes/javax/crypto/spec/IvParameterSpec.java index e396c5b45..fa1eaedd2 100644 --- a/src/share/classes/javax/crypto/spec/IvParameterSpec.java +++ b/src/share/classes/javax/crypto/spec/IvParameterSpec.java @@ -68,7 +68,7 @@ public class IvParameterSpec implements AlgorithmParameterSpec { * starts. * @param len the number of IV bytes. * @throws IllegalArgumentException if iv is null - * or (iv.length - offset < len) + * or {@code (iv.length - offset < len)} * @throws ArrayIndexOutOfBoundsException is thrown if offset * or len index bytes outside the iv. */ diff --git a/src/share/classes/javax/crypto/spec/RC5ParameterSpec.java b/src/share/classes/javax/crypto/spec/RC5ParameterSpec.java index 7248eefa8..499480c2c 100644 --- a/src/share/classes/javax/crypto/spec/RC5ParameterSpec.java +++ b/src/share/classes/javax/crypto/spec/RC5ParameterSpec.java @@ -80,7 +80,7 @@ public class RC5ParameterSpec implements AlgorithmParameterSpec { * bytes of the buffer are copied to protect against subsequent * modification. * @exception IllegalArgumentException if iv is - * null or (iv.length < 2 * (wordSize / 8)) + * null or {@code (iv.length < 2 * (wordSize / 8))} */ public RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv) { this(version, rounds, wordSize, iv, 0); @@ -107,7 +107,7 @@ public class RC5ParameterSpec implements AlgorithmParameterSpec { * @param offset the offset in iv where the IV starts. * @exception IllegalArgumentException if iv is * null or - * (iv.length - offset < 2 * (wordSize / 8)) + * {@code (iv.length - offset < 2 * (wordSize / 8))} */ public RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv, int offset) { diff --git a/src/share/classes/javax/crypto/spec/SecretKeySpec.java b/src/share/classes/javax/crypto/spec/SecretKeySpec.java index 827be0f52..586399dea 100644 --- a/src/share/classes/javax/crypto/spec/SecretKeySpec.java +++ b/src/share/classes/javax/crypto/spec/SecretKeySpec.java @@ -130,7 +130,7 @@ public class SecretKeySpec implements KeySpec, SecretKey { * for information about standard algorithm names. * @exception IllegalArgumentException if algorithm * is null or key is null, empty, or too short, - * i.e. key.length-offset. + * i.e. {@code key.length-offsetoffset or len index bytes outside the * key. diff --git a/src/share/classes/javax/naming/BinaryRefAddr.java b/src/share/classes/javax/naming/BinaryRefAddr.java index 541c03420..711a83408 100644 --- a/src/share/classes/javax/naming/BinaryRefAddr.java +++ b/src/share/classes/javax/naming/BinaryRefAddr.java @@ -89,9 +89,9 @@ public class BinaryRefAddr extends RefAddr { * @param src The non-null contents of the address as a byte array. * The contents of src is copied into the new BinaryRefAddr. * @param offset The starting index in src to get the bytes. - * 0 <= offset <= src.length. + * {@code 0 <= offset <= src.length}. * @param count The number of bytes to extract from src. - * 0 <= count <= src.length-offset. + * {@code 0 <= count <= src.length-offset}. */ public BinaryRefAddr(String addrType, byte[] src, int offset, int count) { super(addrType); diff --git a/src/share/classes/javax/naming/directory/Attribute.java b/src/share/classes/javax/naming/directory/Attribute.java index fda9e3de2..6ed0d9ad5 100644 --- a/src/share/classes/javax/naming/directory/Attribute.java +++ b/src/share/classes/javax/naming/directory/Attribute.java @@ -265,7 +265,7 @@ public interface Attribute extends Cloneable, java.io.Serializable { * If the attribute values are unordered, * this method returns the value that happens to be at that index. * @param ix The index of the value in the ordered list of attribute values. - * 0 <= ix < size(). + * {@code 0 <= ix < size()}. * @return The possibly null attribute value at index ix; * null if the attribute value is null. * @exception NamingException If a naming exception was encountered while @@ -284,7 +284,7 @@ public interface Attribute extends Cloneable, java.io.Serializable { * the front of the list (and their indices decremented by one). * * @param ix The index of the value to remove. - * 0 <= ix < size(). + * {@code 0 <= ix < size()}. * @return The possibly null attribute value at index ix that was removed; * null if the attribute value is null. * @exception IndexOutOfBoundsException If ix is outside the specified range. @@ -302,7 +302,7 @@ public interface Attribute extends Cloneable, java.io.Serializable { * IllegalStateException is thrown. * * @param ix The index in the ordered list of attribute values to add the new value. - * 0 <= ix <= size(). + * {@code 0 <= ix <= size()}. * @param attrVal The possibly null attribute value to add; if null, null is * the value added. * @exception IndexOutOfBoundsException If ix is outside the specified range. @@ -322,7 +322,7 @@ public interface Attribute extends Cloneable, java.io.Serializable { * In that case, IllegalStateException is thrown. * * @param ix The index of the value in the ordered list of attribute values. - * 0 <= ix < size(). + * {@code 0 <= ix < size()}. * @param attrVal The possibly null attribute value to use. * If null, 'null' replaces the old value. * @return The possibly null attribute value at index ix that was replaced. diff --git a/src/share/classes/javax/naming/ldap/LdapName.java b/src/share/classes/javax/naming/ldap/LdapName.java index 256f7530c..ce9453706 100644 --- a/src/share/classes/javax/naming/ldap/LdapName.java +++ b/src/share/classes/javax/naming/ldap/LdapName.java @@ -443,7 +443,7 @@ public class LdapName implements Name { * @throws InvalidNameException if suffix is not a valid LDAP * name, or if the addition of the components would violate the * syntax rules of this LDAP name. - * @throws IndexOutOfBoundsException. + * @throws IndexOutOfBoundsException * If posn is outside the specified range. */ public Name addAll(int posn, Name suffix) @@ -474,7 +474,7 @@ public class LdapName implements Name { * Must be in the range [0,size()]. * * @return The updated name (not a new instance). - * @throws IndexOutOfBoundsException. + * @throws IndexOutOfBoundsException * If posn is outside the specified range. */ public Name addAll(int posn, List suffixRdns) { @@ -527,7 +527,7 @@ public class LdapName implements Name { * Must be in the range [0,size()]. * @return The updated LdapName, not a new instance. * Cannot be null. - * @exception IndexOutOfBoundsException. + * @exception IndexOutOfBoundsException * If posn is outside the specified range. * @exception InvalidNameException If adding comp at the * specified position would violate the name's syntax. diff --git a/src/share/classes/javax/naming/ldap/PagedResultsControl.java b/src/share/classes/javax/naming/ldap/PagedResultsControl.java index 07e29b7a3..18c08e599 100644 --- a/src/share/classes/javax/naming/ldap/PagedResultsControl.java +++ b/src/share/classes/javax/naming/ldap/PagedResultsControl.java @@ -36,7 +36,7 @@ import com.sun.jndi.ldap.BerEncoder; * at which it invokes search operations. *

    * The following code sample shows how the class may be used: - *

    + * 
    {@code
      *
      *     // Open an LDAP association
      *     LdapContext ctx = new InitialLdapContext();
    @@ -89,13 +89,13 @@ import com.sun.jndi.ldap.BerEncoder;
      *     ctx.close();
      *     ...
      *
    - * 
    + * }
    *

    * This class implements the LDAPv3 Control for paged-results as defined in * RFC 2696. * * The control's value has the following ASN.1 definition: - *

    + * 
    {@code
      *
      *     realSearchControlValue ::= SEQUENCE {
      *         size      INTEGER (0..maxInt),
    @@ -104,7 +104,7 @@ import com.sun.jndi.ldap.BerEncoder;
      *         cookie    OCTET STRING
      *     }
      *
    - * 
    + * }
    * * @since 1.5 * @see PagedResultsResponseControl diff --git a/src/share/classes/javax/naming/ldap/SortControl.java b/src/share/classes/javax/naming/ldap/SortControl.java index 486600f72..3aef9fdd9 100644 --- a/src/share/classes/javax/naming/ldap/SortControl.java +++ b/src/share/classes/javax/naming/ldap/SortControl.java @@ -40,7 +40,7 @@ import com.sun.jndi.ldap.BerEncoder; * then the search operation is not performed and an error is returned. *

    * The following code sample shows how the class may be used: - *

    + * 
    {@code
      *
      *     // Open an LDAP association
      *     LdapContext ctx = new InitialLdapContext();
    @@ -85,7 +85,7 @@ import com.sun.jndi.ldap.BerEncoder;
      *     ctx.close();
      *     ...
      *
    - * 
    + * }
    *

    * This class implements the LDAPv3 Request Control for server-side sorting * as defined in diff --git a/src/share/classes/javax/net/ssl/SNIHostName.java b/src/share/classes/javax/net/ssl/SNIHostName.java index 1d02104e1..588a8547e 100644 --- a/src/share/classes/javax/net/ssl/SNIHostName.java +++ b/src/share/classes/javax/net/ssl/SNIHostName.java @@ -295,8 +295,8 @@ public final class SNIHostName extends SNIServerName { * representing the hostname(s) to match * @throws NullPointerException if {@code regex} is * {@code null} - * @throws PatternSyntaxException if the regular expression's syntax - * is invalid + * @throws java.util.regex.PatternSyntaxException if the regular expression's + * syntax is invalid */ public static SNIMatcher createSNIMatcher(String regex) { if (regex == null) { diff --git a/src/share/classes/javax/net/ssl/SSLEngine.java b/src/share/classes/javax/net/ssl/SSLEngine.java index 433361c6a..92e838623 100644 --- a/src/share/classes/javax/net/ssl/SSLEngine.java +++ b/src/share/classes/javax/net/ssl/SSLEngine.java @@ -211,7 +211,7 @@ import java.nio.ReadOnlyBufferException; * that the source buffer has enough room to hold a record (enlarging if * necessary), and then obtain more inbound data. * - *

    + * 
    {@code
      *   SSLEngineResult r = engine.unwrap(src, dst);
      *   switch (r.getStatus()) {
      *   BUFFER_OVERFLOW:
    @@ -238,7 +238,7 @@ import java.nio.ReadOnlyBufferException;
      *       break;
      *   // other cases: CLOSED, OK.
      *   }
    - * 
    + * }
    * *

    * Unlike SSLSocket, all methods of SSLEngine are @@ -442,7 +442,7 @@ public abstract class SSLEngine { *

          * {@link #wrap(ByteBuffer [], int, int, ByteBuffer)
          *     engine.wrap(new ByteBuffer [] { src }, 0, 1, dst);}
    -     * 
    +     * 
    * * @param src * a ByteBuffer containing outbound application data @@ -478,7 +478,7 @@ public abstract class SSLEngine { *
          * {@link #wrap(ByteBuffer [], int, int, ByteBuffer)
          *     engine.wrap(srcs, 0, srcs.length, dst);}
    -     * 
    +     * 
    * * @param srcs * an array of ByteBuffers containing the @@ -597,7 +597,7 @@ public abstract class SSLEngine { *
          * {@link #unwrap(ByteBuffer, ByteBuffer [], int, int)
          *     engine.unwrap(src, new ByteBuffer [] { dst }, 0, 1);}
    -     * 
    +     * 
    * * @param src * a ByteBuffer containing inbound network data. @@ -633,7 +633,7 @@ public abstract class SSLEngine { *
          * {@link #unwrap(ByteBuffer, ByteBuffer [], int, int)
          *     engine.unwrap(src, dsts, 0, dsts.length);}
    -     * 
    +     * 
    * * @param src * a ByteBuffer containing inbound network data. diff --git a/src/share/classes/javax/net/ssl/SSLEngineResult.java b/src/share/classes/javax/net/ssl/SSLEngineResult.java index 45dcddbde..93ad6a7b3 100644 --- a/src/share/classes/javax/net/ssl/SSLEngineResult.java +++ b/src/share/classes/javax/net/ssl/SSLEngineResult.java @@ -173,7 +173,7 @@ public class SSLEngineResult { * * @throws IllegalArgumentException * if the status or handshakeStatus - * arguments are null, or if <bytesConsumed or + * arguments are null, or if bytesConsumed or * bytesProduced is negative. */ public SSLEngineResult(Status status, HandshakeStatus handshakeStatus, diff --git a/src/share/classes/javax/net/ssl/SSLSessionContext.java b/src/share/classes/javax/net/ssl/SSLSessionContext.java index 61f1ddccc..3459545e9 100644 --- a/src/share/classes/javax/net/ssl/SSLSessionContext.java +++ b/src/share/classes/javax/net/ssl/SSLSessionContext.java @@ -90,7 +90,7 @@ public interface SSLSessionContext { * @param seconds the new session timeout limit in seconds; zero means * there is no limit. * - * @exception IllegalArgumentException if the timeout specified is < 0. + * @exception IllegalArgumentException if the timeout specified is {@code < 0}. * @see #getSessionTimeout */ public void setSessionTimeout(int seconds) @@ -122,7 +122,7 @@ public interface SSLSessionContext { * * @param size the new session cache size limit; zero means there is no * limit. - * @exception IllegalArgumentException if the specified size is < 0. + * @exception IllegalArgumentException if the specified size is {@code < 0}. * @see #getSessionCacheSize */ public void setSessionCacheSize(int size) diff --git a/src/share/classes/javax/script/ScriptEngineFactory.java b/src/share/classes/javax/script/ScriptEngineFactory.java index ae064acf9..ca22d1635 100644 --- a/src/share/classes/javax/script/ScriptEngineFactory.java +++ b/src/share/classes/javax/script/ScriptEngineFactory.java @@ -144,8 +144,7 @@ public interface ScriptEngineFactory { * of the supported scripting language. For instance, an implementaton for a Javascript * engine might be; *

    - *

    -     * 
    +     * 
    {@code
          * public String getMethodCallSyntax(String obj,
          *                                   String m, String... args) {
          *      String ret = obj;
    @@ -159,8 +158,7 @@ public interface ScriptEngineFactory {
          *      ret += ")";
          *      return ret;
          * }
    -     *
    -     *
    + * }
    *

    * * @param obj The name representing the object whose method is to be invoked. The @@ -200,17 +198,17 @@ public interface ScriptEngineFactory { * Returns A valid scripting language executable progam with given statements. * For instance an implementation for a PHP engine might be: *

    - *

    
    +     * 
    {@code
          * public String getProgram(String... statements) {
    -     *      $retval = "<?\n";
    +     *      $retval = "";
          *
          * }
    -     * 
    + * }
    * * @param statements The statements to be executed. May be return values of * calls to the getMethodCallSyntax and getOutputStatement methods. diff --git a/src/share/classes/javax/security/auth/callback/CallbackHandler.java b/src/share/classes/javax/security/auth/callback/CallbackHandler.java index 4c6e9a271..843accac9 100644 --- a/src/share/classes/javax/security/auth/callback/CallbackHandler.java +++ b/src/share/classes/javax/security/auth/callback/CallbackHandler.java @@ -79,7 +79,7 @@ public interface CallbackHandler { * This example code is for guidance only. Many details, * including proper error handling, are left out for simplicity. * - *
    +     * 
    {@code
          * public void handle(Callback[] callbacks)
          * throws IOException, UnsupportedCallbackException {
          *
    @@ -133,7 +133,7 @@ public interface CallbackHandler {
          * private char[] readPassword(InputStream in) throws IOException {
          *    // insert code to read a user password from the input stream
          * }
    -     * 
    + * }
    * * @param callbacks an array of Callback objects provided * by an underlying security service which contains diff --git a/src/share/classes/javax/security/sasl/Sasl.java b/src/share/classes/javax/security/sasl/Sasl.java index 6bdc104b9..bb9fb2eec 100644 --- a/src/share/classes/javax/security/sasl/Sasl.java +++ b/src/share/classes/javax/security/sasl/Sasl.java @@ -278,7 +278,7 @@ public class Sasl { * * This method uses the JCA Security Provider Framework, described in the - * "Java Cryptography Architecture API Specification & Reference", for + * "Java Cryptography Architecture API Specification & Reference", for * locating and selecting a SaslClient implementation. * * First, it @@ -303,7 +303,7 @@ public class Sasl { * SaslClientFactory.DIGEST-MD5 com.wiz.sasl.digest.ClientFactory *

    * See the - * "Java Cryptography Architecture API Specification & Reference" + * "Java Cryptography Architecture API Specification & Reference" * for information about how to install and configure security service * providers. * @@ -428,7 +428,7 @@ public class Sasl { * This method uses the JCA Security Provider Framework, * described in the - * "Java Cryptography Architecture API Specification & Reference", for + * "Java Cryptography Architecture API Specification & Reference", for * locating and selecting a SaslServer implementation. * * First, it @@ -453,7 +453,7 @@ public class Sasl { * SaslServerFactory.DIGEST-MD5 com.wiz.sasl.digest.ServerFactory *

    * See the - * "Java Cryptography Architecture API Specification & Reference" + * "Java Cryptography Architecture API Specification & Reference" * for information about how to install and configure security * service providers. * diff --git a/src/share/classes/javax/security/sasl/SaslClient.java b/src/share/classes/javax/security/sasl/SaslClient.java index 010246c4b..10f8d3dc3 100644 --- a/src/share/classes/javax/security/sasl/SaslClient.java +++ b/src/share/classes/javax/security/sasl/SaslClient.java @@ -38,13 +38,13 @@ package javax.security.sasl; *

    * Here's an example of how an LDAP library might use a SaslClient. * It first gets an instance of a SaslClient: - *

    + *
    {@code
      * SaslClient sc = Sasl.createSaslClient(mechanisms,
      *     authorizationId, protocol, serverName, props, callbackHandler);
    - *
    + *}
    * It can then proceed to use the client for authentication. * For example, an LDAP library might use the client as follows: - *
    + *
    {@code
      * // Get initial response and send to server
      * byte[] response = (sc.hasInitialResponse() ? sc.evaluateChallenge(new byte[0]) :
      *     null);
    @@ -74,7 +74,7 @@ package javax.security.sasl;
      *      ldap.out = new SecureOutputStream(sc, ldap.out);
      *    }
      * }
    - *
    + *}
    * * If the mechanism has an initial response, the library invokes * evaluateChallenge() with an empty diff --git a/src/share/classes/javax/security/sasl/SaslServer.java b/src/share/classes/javax/security/sasl/SaslServer.java index 54ba68434..ec5d20a23 100644 --- a/src/share/classes/javax/security/sasl/SaslServer.java +++ b/src/share/classes/javax/security/sasl/SaslServer.java @@ -47,7 +47,7 @@ package javax.security.sasl; * For example, suppose the LDAP server received an LDAP BIND request * containing the name of the SASL mechanism and an (optional) initial * response. It then might use the server as follows: - *
    + *
    {@code
      * while (!ss.isComplete()) {
      *     try {
      *         byte[] challenge = ss.evaluateResponse(response);
    @@ -75,7 +75,7 @@ package javax.security.sasl;
      *      ldap.out = new SecureOutputStream(ss, ldap.out);
      *    }
      * }
    - *
    + *}
    * * @since 1.5 * diff --git a/src/share/classes/javax/smartcardio/ResponseAPDU.java b/src/share/classes/javax/smartcardio/ResponseAPDU.java index 94859e830..7caa52eb5 100644 --- a/src/share/classes/javax/smartcardio/ResponseAPDU.java +++ b/src/share/classes/javax/smartcardio/ResponseAPDU.java @@ -121,7 +121,7 @@ public final class ResponseAPDU implements java.io.Serializable { * Returns the value of the status bytes SW1 and SW2 as a single * status word SW. * It is defined as - * (getSW1() << 8) | getSW2(). + * {@code (getSW1() << 8) | getSW2()} * * @return the value of the status word SW. */ diff --git a/src/share/classes/javax/sql/DataSource.java b/src/share/classes/javax/sql/DataSource.java index d4d9d70dd..8235d2a27 100644 --- a/src/share/classes/javax/sql/DataSource.java +++ b/src/share/classes/javax/sql/DataSource.java @@ -82,7 +82,7 @@ public interface DataSource extends CommonDataSource, Wrapper { * * @return a connection to the data source * @exception SQLException if a database access error occurs - * @throws SQLTimeoutException when the driver has determined that the + * @throws java.sql.SQLTimeoutException when the driver has determined that the * timeout value specified by the {@code setLoginTimeout} method * has been exceeded and has at least tried to cancel the * current database connection attempt @@ -98,7 +98,7 @@ public interface DataSource extends CommonDataSource, Wrapper { * @param password the user's password * @return a connection to the data source * @exception SQLException if a database access error occurs - * @throws SQLTimeoutException when the driver has determined that the + * @throws java.sql.SQLTimeoutException when the driver has determined that the * timeout value specified by the {@code setLoginTimeout} method * has been exceeded and has at least tried to cancel the * current database connection attempt diff --git a/src/share/classes/javax/sql/rowset/BaseRowSet.java b/src/share/classes/javax/sql/rowset/BaseRowSet.java index 1019b8de1..a3b13fa0f 100644 --- a/src/share/classes/javax/sql/rowset/BaseRowSet.java +++ b/src/share/classes/javax/sql/rowset/BaseRowSet.java @@ -109,10 +109,10 @@ import javax.sql.rowset.serial.*; * CachedRowSetTM * object crs might have its command property set. Note that if a * tool is used to set properties, this is the code that the tool would use. - *
    + * 
    {@code
      *    crs.setCommand("SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS" +
      *                   "WHERE CREDIT_LIMIT > ? AND REGION = ?");
    - * 
    + * }
    *

    * In this example, the values for CREDIT_LIMIT and * REGION are placeholder parameters, which are indicated with a @@ -129,16 +129,16 @@ import javax.sql.rowset.serial.*; *

    * The following code fragment demonstrates * setting the two parameters in the query from the previous example. - *

    + * 
    {@code
      *    crs.setInt(1, 5000);
      *    crs.setString(2, "West");
    - * 
    + * }
    * If the execute method is called at this point, the query * sent to the DBMS will be: - *
    + * 
    {@code
      *    "SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS" +
      *                   "WHERE CREDIT_LIMIT > 5000 AND REGION = 'West'"
    - * 
    + * }
    * NOTE: Setting Array, Clob, Blob and * Ref objects as a command parameter, stores these values as * SerialArray, SerialClob, SerialBlob @@ -158,7 +158,7 @@ import javax.sql.rowset.serial.*; * When the method execute is called, the values in the * Hashtable object are substituted for the appropriate placeholder * parameters in the command. - * + *

    * A call to the method getParams returns the values stored in the * Hashtable object as an array of Object instances. * An element in this array may be a simple Object instance or an @@ -2535,7 +2535,7 @@ public abstract class BaseRowSet implements Serializable, Cloneable { * specific abstract data types. *

    * The parameter value set by this method is stored internally and - * will be supplied as the appropriate parameter in this RowSetRowSet * object's command when the method execute is called. * Methods such as execute and populate must be * provided in any class that extends this class and implements one or diff --git a/src/share/classes/javax/sql/rowset/CachedRowSet.java b/src/share/classes/javax/sql/rowset/CachedRowSet.java index 786122391..1a8517520 100644 --- a/src/share/classes/javax/sql/rowset/CachedRowSet.java +++ b/src/share/classes/javax/sql/rowset/CachedRowSet.java @@ -118,7 +118,7 @@ import javax.sql.rowset.spi.*; *

    * There are two ways for a CachedRowSet object to specify which * SyncProvider object it will use. - * *

  • Supplying the name of the implementation to the constructor
    * The following line of code creates the CachedRowSet * object crs2 that is initialized with default values except that its @@ -135,7 +135,7 @@ import javax.sql.rowset.spi.*; *
      *           crs.setSyncProvider("com.fred.providers.HighAvailabilityProvider");
      *      
    - * * See the comments for SyncFactory and SyncProvider for * more details. * @@ -426,10 +426,10 @@ import javax.sql.rowset.spi.*; * The following code fragment illustrates how the CachedRowSet * object crs might have its command property set. Note that if a * tool is used to set properties, this is the code that the tool would use. - *
    + * 
    {@code
      *    crs.setCommand("SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS " +
      *                   "WHERE CREDIT_LIMIT > ? AND REGION = ?");
    - * 
    + * }
    *

    * The values that will be used to set the command's placeholder parameters are * contained in the RowSet object's params field, which is a @@ -457,7 +457,7 @@ import javax.sql.rowset.spi.*; * The following code fragment gives an idea of how the reader * does this, after obtaining the Connection object * con. - *

    + * 
    {@code
      *    PreparedStatement pstmt = con.prepareStatement(crs.getCommand());
      *    reader.decodeParams();
      *    // decodeParams figures out which setter methods to use and does something
    @@ -465,16 +465,16 @@ import javax.sql.rowset.spi.*;
      *    //    for (i = 0; i < params.length; i++) {
      *    //        pstmt.setObject(i + 1, params[i]);
      *    //    }
    - * 
    + * }
    *

    - * At this point, the command for crs is the query "SELECT + * At this point, the command for crs is the query {@code "SELECT * FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS WHERE CREDIT_LIMIT > 5000 - * AND REGION = "West". After the readData method executes + * AND REGION = "West"}. After the readData method executes * this command with the following line of code, it will have the data from * rs with which to populate crs. - *

    + * 
    {@code
      *     ResultSet rs = pstmt.executeQuery();
    - * 
    + * }
    *

    * The preceding code fragments give an idea of what goes on behind the * scenes; they would not appear in an application, which would not invoke @@ -484,13 +484,13 @@ import javax.sql.rowset.spi.*; * the command. Simply by calling the execute method, * crs populates itself with the requested data from the * table CUSTOMERS. - *

    + * 
    {@code
      *    crs.setCommand("SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS" +
      *                   "WHERE CREDIT_LIMIT > ? AND REGION = ?");
      *    crs.setInt(1, 5000);
      *    crs.setString(2, "West");
      *    crs.execute();
    - * 
    + * }
    * *

    10.0 Paging Data

    * Because a CachedRowSet object stores data in memory, diff --git a/src/share/classes/javax/sql/rowset/Predicate.java b/src/share/classes/javax/sql/rowset/Predicate.java index a9672c98e..eb747602e 100644 --- a/src/share/classes/javax/sql/rowset/Predicate.java +++ b/src/share/classes/javax/sql/rowset/Predicate.java @@ -53,8 +53,7 @@ import java.sql.*; * and application motivated implementations of Predicate to emerge. *

    * A sample implementation would look something like this: - *

    - * 
    + * 
    {@code
      *    public class Range implements Predicate {
      *
      *       private Object lo[];
    @@ -79,19 +78,19 @@ import java.sql.*;
      *              if ((rs.getObject(idx[i]) >= lo[i]) &&
      *                  (rs.getObject(idx[i]) >= hi[i]) {
      *                  bool1 = true; // within filter constraints
    - *          } else {
    - *            bool2 = true; // outside of filter constraints
    + *              } else {
    + *                  bool2 = true; // outside of filter constraints
    + *              }
      *          }
    - *      }
      *
    - *      if (bool2) {
    - *         return false;
    - *      } else {
    - *         return true;
    + *          if (bool2) {
    + *             return false;
    + *          } else {
    + *             return true;
    + *          }
      *      }
      *  }
    - * 
    - * 
    + * }
    *

    * The example above implements a simple range predicate. Note, that * implementations should but are not required to provider String diff --git a/src/share/classes/javax/sql/rowset/RowSetMetaDataImpl.java b/src/share/classes/javax/sql/rowset/RowSetMetaDataImpl.java index e1b78a920..a5c998170 100644 --- a/src/share/classes/javax/sql/rowset/RowSetMetaDataImpl.java +++ b/src/share/classes/javax/sql/rowset/RowSetMetaDataImpl.java @@ -159,7 +159,7 @@ public class RowSetMetaDataImpl implements RowSetMetaData, Serializable { * @param property true if the given column is * automatically incremented; false * otherwise - * @throws SQLException if a database access error occurs or + * @throws SQLException if a database access error occurs or * the given index is out of bounds */ public void setAutoIncrement(int columnIndex, boolean property) throws SQLException { @@ -195,7 +195,7 @@ public class RowSetMetaDataImpl implements RowSetMetaData, Serializable { * value can be used in a WHERE clause; * false otherwise * - * @throws SQLException if a database access error occurs or + * @throws SQLException if a database access error occurs or * the given column number is out of bounds */ public void setSearchable(int columnIndex, boolean property) @@ -212,7 +212,7 @@ public class RowSetMetaDataImpl implements RowSetMetaData, Serializable { * must be between 1 and the number of columns, * inclusive between 1 and the number of columns, inclusive * @param property true if the value is a cash value; false otherwise. - * @throws SQLException if a database access error occurs + * @throws SQLException if a database access error occurs * or the given column number is out of bounds */ public void setCurrency(int columnIndex, boolean property) @@ -233,7 +233,7 @@ public class RowSetMetaDataImpl implements RowSetMetaData, Serializable { * columnNullable, or * columnNullableUnknown * - * @throws SQLException if a database access error occurs, + * @throws SQLException if a database access error occurs, * the given column number is out of bounds, or the value supplied * for the property parameter is not one of the following * constants: diff --git a/src/share/classes/javax/sql/rowset/spi/SyncFactory.java b/src/share/classes/javax/sql/rowset/spi/SyncFactory.java index 10e6158e7..e9b10bdcb 100644 --- a/src/share/classes/javax/sql/rowset/spi/SyncFactory.java +++ b/src/share/classes/javax/sql/rowset/spi/SyncFactory.java @@ -627,8 +627,6 @@ public class SyncFactory { * required * @throws java.lang.SecurityException if a security manager exists and its * {@code checkPermission} method denies calling {@code setLogger} - * @throws java.util.logging.LoggingPermission if a security manager exists and its - * {@code checkPermission} method denies calling {@code setLevel} * @throws NullPointerException if the logger is null * @see SecurityManager#checkPermission * @see LoggingPermission diff --git a/src/share/classes/javax/sql/rowset/spi/SyncResolver.java b/src/share/classes/javax/sql/rowset/spi/SyncResolver.java index 87b5393a7..c1180cf92 100644 --- a/src/share/classes/javax/sql/rowset/spi/SyncResolver.java +++ b/src/share/classes/javax/sql/rowset/spi/SyncResolver.java @@ -193,7 +193,7 @@ import java.sql.SQLException; * code fragment, the value in crs is the one set as the resolved value, which means * that it will be used to overwrite the conflict value in the data source. * - *

    + * 
    {@code
      *     try {
      *
      *         crs.acceptChanges(con);
    @@ -202,8 +202,8 @@ import java.sql.SQLException;
      *
      *         SyncResolver resolver = spe.getSyncResolver();
      *
    - *         Object crsValue;  // value in the RowSet object
    - *         Object resolverValue:  // value in the SyncResolver object
    + *         Object crsValue;  // value in the RowSet object
    + *         Object resolverValue:  // value in the SyncResolver object
      *         Object resolvedValue:  // value to be persisted
      *
      *         while(resolver.nextConflict())  {
    @@ -227,7 +227,7 @@ import java.sql.SQLException;
      *              }
      *          }
      *      }
    - * 
    + * }
    * @author Jonathan Bruce */ diff --git a/src/share/classes/javax/xml/crypto/dsig/Manifest.java b/src/share/classes/javax/xml/crypto/dsig/Manifest.java index 7df2c2306..8c7662640 100644 --- a/src/share/classes/javax/xml/crypto/dsig/Manifest.java +++ b/src/share/classes/javax/xml/crypto/dsig/Manifest.java @@ -35,15 +35,15 @@ import java.util.List; * the * W3C Recommendation for XML-Signature Syntax and Processing. * The XML Schema Definition is defined as: - *
    
    - * <element name="Manifest" type="ds:ManifestType"/>
    - *   <complexType name="ManifestType">
    - *     <sequence>
    - *       <element ref="ds:Reference" maxOccurs="unbounded"/>
    - *     </sequence>
    - *     <attribute name="Id" type="ID" use="optional"/>
    - *   </complexType>
    - * 
    + *
    {@code
    + * 
    + *   
    + *     
    + *       
    + *     
    + *     
    + *   
    + * }
    * * A Manifest instance may be created by invoking * one of the {@link XMLSignatureFactory#newManifest newManifest} -- GitLab