+2004-04-20 Michael Koch <konqueror@gmx.de>
+
+ * java/rmi/MarshalledObject.java,
+ java/rmi/Naming.java,
+ java/rmi/RemoteException.java,
+ java/rmi/activation/ActivationException.java,
+ java/rmi/server/ServerCloneException.java,
+ java/security/AccessController.java,
+ java/security/AlgorithmParameterGenerator.java,
+ java/security/AlgorithmParameters.java,
+ java/security/CodeSource.java,
+ java/security/Identity.java,
+ java/security/IdentityScope.java,
+ java/security/KeyPairGenerator.java,
+ java/security/KeyStore.java,
+ java/security/Security.java,
+ java/security/Signature.java,
+ java/security/SignatureSpi.java,
+ java/security/SignedObject.java,
+ java/security/spec/DSAParameterSpec.java,
+ java/security/spec/DSAPrivateKeySpec.java,
+ java/security/spec/DSAPublicKeySpec.java,
+ java/sql/Array.java,
+ java/sql/DatabaseMetaData.java,
+ java/sql/ResultSet.java,
+ java/text/ChoiceFormat.java,
+ java/text/CollationElementIterator.java,
+ java/text/CollationKey.java,
+ java/text/Collator.java,
+ java/text/DateFormat.java,
+ java/text/DateFormatSymbols.java,
+ java/text/DecimalFormatSymbols.java,
+ java/text/Format.java,
+ java/text/ParsePosition.java,
+ java/text/RuleBasedCollator.java,
+ java/text/SimpleDateFormat.java,
+ java/text/StringCharacterIterator.java,
+ java/util/Collections.java,
+ java/util/PropertyResourceBundle.java,
+ java/util/ResourceBundle.java,
+ java/util/StringTokenizer.java,
+ java/util/jar/Attributes.java,
+ java/util/logging/ConsoleHandler.java,
+ java/util/logging/LogManager.java,
+ java/util/logging/MemoryHandler.java,
+ java/util/logging/SocketHandler.java,
+ javax/naming/NamingException.java:
+ Fixed javadoc, coding style and argument names all over.
+
2004-04-20 Jeroen Frijters <jeroen@frijters.net>
* java/io/FileDescriptor.java: (FileDescriptor) Added public
/*
- Copyright (c) 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
+ Copyright (c) 1996, 1997, 1998, 1999, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
/**
* FIXME - doc missing
*/
-public final class MarshalledObject
- extends Object implements Serializable
+public final class MarshalledObject implements Serializable
{
//The following fields are from Java API Documentation "Serialized form"
public final class Naming {
-/** <pre>
+/**
* Looks for the remote object that is associated with the named service.
* Name and location is given in form of a URL without a scheme:
- *
- * //host:port/service-name
+ *
+ * <pre>
+ * //host:port/service-name
+ * </pre>
*
* The port is optional.
- * </pre>
+ *
* @param name the service name and location
* @return Remote-object that implements the named service
* @throws NotBoundException if no object implements the service
* This method returns a message indicating what went wrong, in this
* format:
* <code>super.getMessage() + (detail == null ? ""
- * : "; nested exception is:\n\t" + detail)<code>.
+ * : "; nested exception is:\n\t" + detail)</code>.
*
* @return the chained message
*/
* This method returns a message indicating what went wrong, in this
* format:
* <code>super.getMessage() + (detail == null ? ""
- * : "; nested exception is:\n\t" + detail)<code>.
+ * : "; nested exception is:\n\t" + detail)</code>.
*
* @return the chained message
*/
* This method returns a message indicating what went wrong, in this
* format:
* <code>super.getMessage() + (detail == null ? ""
- * : "; nested exception is:\n\t" + detail)<code>.
+ * : "; nested exception is:\n\t" + detail)</code>.
*
* @return the chained message
*/
/* AccessController.java --- Access control context and permission checker
- Copyright (C) 2001 Free Software Foundation, Inc.
+ Copyright (C) 2001, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
*
* @param action the <code>PrivilegedAction</code> whose <code>run()</code>
* should be be called.
- * @returns the result of the <code>action.run()</code> method.
+ * @return the result of the <code>action.run()</code> method.
*/
public static Object doPrivileged(PrivilegedAction action)
{
* should be be called.
* @param context the <code>AccessControlContext</code> whose protection
* domains should be added to the protection domain of the calling class.
- * @returns the result of the <code>action.run()</code> method.
+ * @return the result of the <code>action.run()</code> method.
*/
public static Object doPrivileged(PrivilegedAction action,
AccessControlContext context)
*
* @param action the <code>PrivilegedExceptionAction</code> whose
* <code>run()</code> should be be called.
- * @returns the result of the <code>action.run()</code> method.
+ * @return the result of the <code>action.run()</code> method.
* @exception PrivilegedActionException wrapped around any exception that
* is thrown in the <code>run()</code> method.
*/
* <code>run()</code> should be be called.
* @param context the <code>AccessControlContext</code> whose protection
* domains should be added to the protection domain of the calling class.
- * @returns the result of the <code>action.run()</code> method.
+ * @return the result of the <code>action.run()</code> method.
* @exception PrivilegedActionException wrapped around any exception that
* is thrown in the <code>run()</code> method.
*/
* system parameters, for example, the parameter generation values usually
* consist of the size of the prime modulus and the size of the random
* exponent, both specified in number of bits.</li>
- * <ul>
+ * </ul>
*
* <p>In case the client does not explicitly initialize the
* <code>AlgorithmParameterGenerator</code> (via a call to an <code>init()</code>
* parameter specification or parameter encoding.</p>
*
* <p>A transparent parameter specification is obtained from an
- * <ocde>AlgorithmParameters</code> object via a call to
+ * <code>AlgorithmParameters</code> object via a call to
* <code>getParameterSpec()</code>, and a byte encoding of the parameters is
* obtained via a call to <code>getEncoded()</code>.</p>
*
* object must have all the certifcates this object has (but may have more),
* and must have a location that is a subset of this object's. In order
* for this object to imply the specified object, the following must be
- * true:<ol>
+ * true:
+ *
+ * <ol>
* <li><em>codesource</em> must not be <code>null</code>.</li>
* <li>If <em>codesource</em> has a certificate list, all of it's
* certificates must be present in the certificate list of this
* code source.</li>
* <li>If this object does not have a <code>null</code> location, then
- * the following addtional tests must be passed.<ol>
+ * the following addtional tests must be passed.
+ *
+ * <ol>
* <li><em>codesource</em> must not have a <code>null</code>
* location.</li>
* <li><em>codesource</em>'s location must be equal to this object's
- * location, or<br><ul>
+ * location, or
+ * <ul>
* <li><em>codesource</em>'s location protocol, port, and ref (aka,
* anchor) must equal this objects</li>
* <li><em>codesource</em>'s location host must imply this object's
* location file must start with this object's location file
* with the '/' character appended to it.</li>
* </ul></li>
- * </ol>
+ * </ol></li>
* </ol>
*
* <p>For example, each of these locations imply the location
- * "http://java.sun.com/classes/foo.jar":<ul>
+ * "http://java.sun.com/classes/foo.jar":</p>
+ *
* <pre>
* http:
* http://*.sun.com/classes/*
* http://java.sun.com/classes/-
* http://java.sun.com/classes/foo.jar
* </pre>
- * Note that the code source with null location and null certificates implies
- * all other code sources.
+ *
+ * <p>Note that the code source with null location and null certificates implies
+ * all other code sources.</p>
*
* @param cs the <code>CodeSource</code> to test against this object
* @return true if this specified <code>CodeSource</code> is implied
/**
* This method returns a <code>String</code> that represents this object.
* The result is in the format <code>"(" + getLocation()</code> followed
- * by a space separated list of certificates (or "<no certificates>"),
+ * by a space separated list of certificates (or "<no certificates>"),
* followed by <code>")"</code>.
*
* @return a <code>String</code> for this object
* @throws KeyManagementException if another identity in the identity's scope
* has the same public key, or if another exception occurs.
* @throws SecurityException if a security manager exists and its
- * <code>checkSecurityAccess()<code> method doesn't allow setting the public
+ * <code>checkSecurityAccess()</code> method doesn't allow setting the public
* key.
* @see #getPublicKey()
* @see SecurityManager#checkSecurityAccess(String)
}
/**
- * <p>Sets the system's identity scope.</p>
+ * Sets the system's identity scope.
*
* <p>First, if there is a security manager, its <code>checkSecurityAccess()
* </code> method is called with <code>"setSystemScope"</code> as its argument
*
* @param scope the scope to set.
* @throws SecurityException if a security manager exists and its
- * <code>checkSecurityAccess()<code> method doesn't allow setting the
+ * <code>checkSecurityAccess()</code> method doesn't allow setting the
* identity scope.
* @see #getSystemScope()
* @see SecurityManager#checkSecurityAccess(String)
* two is the initialization of the object:</p>
*
* <ul>
- * <li><b>Algorithm-Independent Initialization</b><br/>
- * All key pair generators share the concepts of a <i>keysize</i> and a
- * <i>source of randomness</i>. The <i>keysize</i> is interpreted differently
- * for different algorithms (e.g., in the case of the <i>DSA</i> algorithm,
- * the <i>keysize</i> corresponds to the length of the modulus). There is an
- * <code>initialize()</code> method in this <code>KeyPairGenerator</code>
- * class that takes these two universally shared types of arguments. There
- * is also one that takes just a <i>keysize</i> argument, and uses the
- * {@link SecureRandom} implementation of the highest-priority installed
- * provider as the <i>source of randomness</i>. (If none of the installed
- * providers supply an implementation of {@link SecureRandom}, a
- * system-provided source of randomness is used.)<br/><br/>
+ * <li><b>Algorithm-Independent Initialization</b><br/>
+ * All key pair generators share the concepts of a <i>keysize</i> and a
+ * <i>source of randomness</i>. The <i>keysize</i> is interpreted differently
+ * for different algorithms (e.g., in the case of the <i>DSA</i> algorithm,
+ * the <i>keysize</i> corresponds to the length of the modulus). There is an
+ * <code>initialize()</code> method in this <code>KeyPairGenerator</code>
+ * class that takes these two universally shared types of arguments. There
+ * is also one that takes just a <i>keysize</i> argument, and uses the
+ * {@link SecureRandom} implementation of the highest-priority installed
+ * provider as the <i>source of randomness</i>. (If none of the installed
+ * providers supply an implementation of {@link SecureRandom}, a
+ * system-provided source of randomness is used.)
*
- * Since no other parameters are specified when you call the above
- * algorithm-independent initialize methods, it is up to the provider what
- * to do about the algorithm-specific parameters (if any) to be associated
- * with each of the keys.<br/><br/>
+ * <p>Since no other parameters are specified when you call the above
+ * algorithm-independent initialize methods, it is up to the provider what
+ * to do about the algorithm-specific parameters (if any) to be associated
+ * with each of the keys.</p>
*
- * If the algorithm is the <i>DSA</i> algorithm, and the <i>keysize</i>
- * (modulus size) is <code>512</code>, <code>768</code>, or <code>1024</code>,
- * then the <b>GNU</b> provider uses a set of precomputed values for the
- * <code>p</code>, <code>q</code>, and <code>g</code> parameters. If the
- * <i>modulus size</i> is not one of the above values, the <b>GNU</b>
- * provider creates a new set of parameters. Other providers might have
- * precomputed parameter sets for more than just the three modulus sizes
- * mentioned above. Still others might not have a list of precomputed
- * parameters at all and instead always create new parameter sets.<br/></li>
- *
- * <li><b>Algorithm-Specific Initialization</b><br/>
- * For situations where a set of algorithm-specific parameters already
- * exists (e.g., so-called <i>community parameters</i> in <i>DSA</i>), there
- * are two initialize methods that have an {@link AlgorithmParameterSpec}
- * argument. One also has a {@link SecureRandom} argument, while the the
- * other uses the {@link SecureRandom} implementation of the highest-priority
- * installed provider as the source of randomness. (If none of the installed
- * providers supply an implementation of {@link SecureRandom}, a
- * system-provided source of randomness is used.)</li>
+ * <p>If the algorithm is the <i>DSA</i> algorithm, and the <i>keysize</i>
+ * (modulus size) is <code>512</code>, <code>768</code>, or <code>1024</code>,
+ * then the <b>GNU</b> provider uses a set of precomputed values for the
+ * <code>p</code>, <code>q</code>, and <code>g</code> parameters. If the
+ * <i>modulus size</i> is not one of the above values, the <b>GNU</b>
+ * provider creates a new set of parameters. Other providers might have
+ * precomputed parameter sets for more than just the three modulus sizes
+ * mentioned above. Still others might not have a list of precomputed
+ * parameters at all and instead always create new parameter sets.</p></li>
+ * <li><b>Algorithm-Specific Initialization</b><br/>
+ * For situations where a set of algorithm-specific parameters already
+ * exists (e.g., so-called <i>community parameters</i> in <i>DSA</i>), there
+ * are two initialize methods that have an {@link AlgorithmParameterSpec}
+ * argument. One also has a {@link SecureRandom} argument, while the the
+ * other uses the {@link SecureRandom} implementation of the highest-priority
+ * installed provider as the source of randomness. (If none of the installed
+ * providers supply an implementation of {@link SecureRandom}, a
+ * system-provided source of randomness is used.)</li>
* </ul>
*
* <p>In case the client does not explicitly initialize the
/**
* Returns the default KeyStore type. This method looks up the
- * type in <JAVA_HOME>/lib/security/java.security with the
+ * type in <JAVA_HOME>/lib/security/java.security with the
* property "keystore.type" or if that fails then "jks" .
*/
public static final String getDefaultType()
/* Security.java --- Java base security class implementation
- Copyright (C) 1999, 2001, 2002, 2003, Free Software Foundation, Inc.
+ Copyright (C) 1999, 2001, 2002, 2003, 2004, Free Software Foundation, Inc.
This file is part of GNU Classpath.
*
* @author Mark Benvenuto <ivymccough@worldnet.att.net>
*/
-public final class Security extends Object
+public final class Security
{
private static final String ALG_ALIAS = "Alg.Alias.";
outer: for (int r = 0; r < 3; r++) // guard against circularity
{
serviceDotAlgorithm = (svc+"."+String.valueOf(algo)).trim();
- inner: for (it = p.keySet().iterator(); it.hasNext(); )
+ for (it = p.keySet().iterator(); it.hasNext(); )
{
key = (String) it.next();
if (key.equalsIgnoreCase(serviceDotAlgorithm)) // eureka
* either signing data or verifying a signature:</p>
*
* <ol>
- * <li>Initialization, with either
- * <li>a public key, which initializes the signature for verification
- * (see <code>initVerify()</code>), or</li>
- * <li>a private key (and optionally a Secure Random Number Generator),
- * which initializes the signature for signing (see
- * {@link #initSign(PrivateKey)} and {@link #initSign(PrivateKey, SecureRandom)}
- * ).</li>
- * </ul></li>
- * <li>Updating<br/>
- * Depending on the type of initialization, this will update the bytes to
- * be signed or verified. See the update methods.<br/></li>
- * <li>Signing or Verifying a signature on all updated bytes. See the
- * <code>sign()</code> methods and the <code>verify()</code> method.</li>
+ * <li>Initialization, with either
+ * <ul>
+ * <li>a public key, which initializes the signature for verification
+ * (see <code>initVerify()</code>), or</li>
+ * <li>a private key (and optionally a Secure Random Number Generator),
+ * which initializes the signature for signing (see
+ * {@link #initSign(PrivateKey)} and {@link #initSign(PrivateKey, SecureRandom)}
+ * ).</li>
+ * </ul></li>
+ * <li>Updating<br/>
+ * Depending on the type of initialization, this will update the bytes to
+ * be signed or verified. See the update methods.<br/></li>
+ * <li>Signing or Verifying a signature on all updated bytes. See the
+ * <code>sign()</code> methods and the <code>verify()</code> method.</li>
* </ol>
*
* <p>Note that this class is abstract and extends from {@link SignatureSpi} for
* superclass are intended for cryptographic service providers who wish to
* supply their own implementations of digital signature algorithms.
*
- * @author Mark Benvenuto <ivymccough@worldnet.att.net>
+ * @author Mark Benvenuto (ivymccough@worldnet.att.net)
*/
public abstract class Signature extends SignatureSpi
{
* @param param the string name of the parameter.
* @return the object that represents the parameter value, or <code>null</code>
* if there is none.
- * @throws InvalidParameterException if <code>param<?code> is an invalid
+ * @throws InvalidParameterException if <code>param</code> is an invalid
* parameter for this engine, or another exception occurs while trying to get
* this parameter.
* @deprecated
* <p>The signature algorithm can be, among others, the NIST standard <i>DSS</i>,
* using <i>DSA</i> and <i>SHA-1</i>. The algorithm is specified using the same
* convention as that for signatures. The <i>DSA</i> algorithm using the
- * </i>SHA-1</i> message digest algorithm can be specified, for example, as
+ * <i>SHA-1</i> message digest algorithm can be specified, for example, as
* <code>"SHA/DSA"</code> or <code>"SHA-1/DSA"</code> (they are equivalent). In
* the case of <i>RSA</i>, there are multiple choices for the message digest
* algorithm, so the signing algorithm could be specified as, for example,
/* DSAParameterSpec.java --- DSA Parameter Specificaton class
- Copyright (C) 1999 Free Software Foundation, Inc.
+ Copyright (C) 1999, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@author Mark Benvenuto
*/
-public class DSAParameterSpec extends Object implements AlgorithmParameterSpec, DSAParams
+public class DSAParameterSpec implements AlgorithmParameterSpec, DSAParams
{
private BigInteger p = null;
private BigInteger q = null;
/* DSAPrivateKeySpec.java --- DSA Private Key Specificaton class
- Copyright (C) 1999 Free Software Foundation, Inc.
+ Copyright (C) 1999, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@author Mark Benvenuto
*/
-public class DSAPrivateKeySpec extends Object implements KeySpec
+public class DSAPrivateKeySpec implements KeySpec
{
private BigInteger x = null;
private BigInteger p = null;
/* DSAPublicKeySpec.java --- DSA Public Key Specificaton class
- Copyright (C) 1999 Free Software Foundation, Inc.
+ Copyright (C) 1999, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@author Mark Benvenuto
*/
-public class DSAPublicKeySpec extends Object implements KeySpec
+public class DSAPublicKeySpec implements KeySpec
{
private BigInteger y = null;
private BigInteger p = null;
/**
* This method returns a portion of the array as a <code>ResultSet</code>.
* The returned portion will start at <code>index</code> into the
- * array and up to <cod>count</code> elements will be returned.
- * <p>
- * Each row of the result set will have two columns. The first will be
+ * array and up to <code>count</code> elements will be returned.
+ *
+ * <p> Each row of the result set will have two columns. The first will be
* the index into the array of that row's contents. The second will be
* the actual value of that array element. The specified <code>Map</code>
* will be used to override selected default mappings of SQL types to
- * Java classes.
+ * Java classes.</p>
*
* @param offset The index into the array to start returning elements from.
* @param length The requested number of elements to return.
* each table.
*
* @return <code>true</code> if the database uses a separate file for each
- * table </code>false</code> otherwise.
+ * table <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
* This method tests whether or not the database treats mixed case
* identifiers as all upper case.
*
- * @exception <code>true</code> if the database treats all identifiers as
- * upper case, <code>false</code> otherwise.
+ * @return <code>true</code> if the database treats all identifiers as
+ * upper case, <code>false</code> otherwise.
* @exception SQLException If an error occurs.
*/
boolean storesUpperCaseIdentifiers() throws SQLException;
* This method tests whether or not the database treats mixed case
* identifiers as all lower case.
*
- * @exception <code>true</code> if the database treats all identifiers as
- * lower case, <code>false</code> otherwise.
+ * @return <code>true</code> if the database treats all identifiers as
+ * lower case, <code>false</code> otherwise.
* @exception SQLException If an error occurs.
*/
boolean storesLowerCaseIdentifiers() throws SQLException;
* This method tests whether or not the database treats mixed case
* quoted identifiers as all upper case.
*
- * @exception <code>true</code> if the database treats all quoted identifiers
- * as upper case, <code>false</code> otherwise.
+ * @return <code>true</code> if the database treats all quoted identifiers
+ * as upper case, <code>false</code> otherwise.
* @exception SQLException If an error occurs.
*/
boolean storesUpperCaseQuotedIdentifiers() throws SQLException;
* This method tests whether or not the database treats mixed case
* quoted identifiers as all lower case.
*
- * @exception <code>true</code> if the database treats all quoted identifiers
- * as lower case, <code>false</code> otherwise.
+ * @return <code>true</code> if the database treats all quoted identifiers
+ * as lower case, <code>false</code> otherwise.
* @exception SQLException If an error occurs.
*/
boolean storesLowerCaseQuotedIdentifiers() throws SQLException;
* <p>
* <ol>
* <li>PROCEDURE_CAT - The catalog the procedure is in, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>PROCEDURE_SCHEM - The schema the procedures is in, which may be
- * <code>null</code>.
- * <li>PROCEDURE_NAME - The name of the procedure.
- * <li>Unused
- * <li>Unused
- * <li>Unused
- * <li>REMARKS - A description of the procedure
+ * <code>null</code>.</li>
+ * <li>PROCEDURE_NAME - The name of the procedure.</li>
+ * <li>Unused</li>
+ * <li>Unused</li>
+ * <li>Unused</li>
+ * <li>REMARKS - A description of the procedure</li>
* <li>PROCEDURE_TYPE - Indicates the return type of the procedure, which
* is one of the contstants defined in this class
* (<code>procedureResultUnknown</code>, <code>procedureNoResult</code>, or
- * <code>procedureReturnsResult</code>).
+ * <code>procedureReturnsResult</code>).</li>
* </ol>
*
* @param catalog The name of the catalog to return stored procedured from,
* <p>
* <ol>
* <li>PROCEDURE_CAT - The catalog the procedure is in, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>PROCEDURE_SCHEM - The schema the procedures is in, which may be
- * <code>null</code>.
- * <li>PROCEDURE_NAME - The name of the procedure.
- * <li>COLUMN_NAME - The name of the column
+ * <code>null</code>.</li>
+ * <li>PROCEDURE_NAME - The name of the procedure.</li>
+ * <li>COLUMN_NAME - The name of the column</li>
* <li>COLUMN_TYPE - The type of the column, which will be one of the
* contants defined in this class (<code>procedureColumnUnknown</code>,
* <code>procedureColumnIn</code>, <code>procedureColumnInOut</code>,
* <code>procedureColumnOut</code>, <code>procedureColumnReturn</code>,
- * or <code>procedureColumnResult</code>).
+ * or <code>procedureColumnResult</code>).</li>
* <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.
- * <li>TYPE_NAME - The string name of the data type for this column.
- * <li>PRECISION - The precision of the column.
- * <li>LENGTH - The length of the column in bytes
- * <li>SCALE - The scale of the column.
- * <li>RADIX - The radix of the column.
+ * defined in <code>Types</code>.</li>
+ * <li>TYPE_NAME - The string name of the data type for this column.</li>
+ * <li>PRECISION - The precision of the column.</li>
+ * <li>LENGTH - The length of the column in bytes</li>
+ * <li>SCALE - The scale of the column.</li>
+ * <li>RADIX - The radix of the column.</li>
* <li>NULLABLE - Whether or not the column is NULLABLE. This is one of
* the constants defined in this class (<code>procedureNoNulls</code>,
- * <code>procedureNullable</code>, or <code>procedureNullableUnknown</code>)
- * <li>REMARKS - A description of the column.
+ * <code>procedureNullable</code>, or <code>procedureNullableUnknown</code>)</li>
+ * <li>REMARKS - A description of the column.</li>
* </ol>
*
* @param catalog The name of the catalog to return stored procedured from,
/**
* This method returns a list of the requested table as a
* <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>TABLE_CAT - The catalog the table is in, which may be <code>null</code>.
- * <li>TABLE_SCHEM - The schema the table is in, which may be <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
+ * <li>TABLE_CAT - The catalog the table is in, which may be <code>null</code>.</li>
+ * <li>TABLE_SCHEM - The schema the table is in, which may be <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
* <li>TABLE_TYPE - A string describing the table type. This will be one
- * of the values returned by the <code>getTableTypes()</code> method.
- * <li>REMARKS - Comments about the table.
+ * of the values returned by the <code>getTableTypes()</code> method.</li>
+ * <li>REMARKS - Comments about the table.</li>
* </ol>
*
* @param catalog The name of the catalog to return tables from,
* <p>
* <ol>
* <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
- * <li>COLUMN_NAME - The name of the column
+ * <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
+ * <li>COLUMN_NAME - The name of the column</li>
* <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.
- * <li>TYPE_NAME - The string name of the data type for this column.
- * <li>COLUMN_SIZE - The size of the column.
- * <li>Unused
- * <li>NUM_PREC_RADIX - The radix of the column.
+ * defined in <code>Types</code>.</li>
+ * <li>TYPE_NAME - The string name of the data type for this column.</li>
+ * <li>COLUMN_SIZE - The size of the column.</li>
+ * <li>Unused</li>
+ * <li>NUM_PREC_RADIX - The radix of the column.</li>
* <li>NULLABLE - Whether or not the column is NULLABLE. This is one of
* the constants defined in this class (<code>tableNoNulls</code>,
- * <code>tableNullable</code>, or <code>tableNullableUnknown</code>)
- * <li>REMARKS - A description of the column.
- * <li>COLUMN_DEF - The default value for the column, may be <code>null</code>.
- * <li>SQL_DATA_TYPE - Unused
- * <li>SQL_DATETIME_SUB - Unused
+ * <code>tableNullable</code>, or <code>tableNullableUnknown</code>)</li>
+ * <li>REMARKS - A description of the column.</li>
+ * <li>COLUMN_DEF - The default value for the column, may be <code>null</code>.</li>
+ * <li>SQL_DATA_TYPE - Unused</li>
+ * <li>SQL_DATETIME_SUB - Unused</li>
* <li>CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes
- * in the column.
- * <li>ORDINAL_POSITION - The index of the column in the table.
+ * in the column.</li>
+ * <li>ORDINAL_POSITION - The index of the column in the table.</li>
* <li>IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string
- * means unknown.
+ * means unknown.</li>
* </ol>
*
* @param catalog The name of the catalog to return table from,
* This method returns the access rights that have been granted to the
* requested columns. This information is returned as a <code>ResultSet</code>
* with the following columns:
- * <p>
+ *
* <ol>
* <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
- * <li>COLUMN_NAME - The name of the column.
- * <li>GRANTOR - The entity that granted the access.
- * <li>GRANTEE - The entity granted the access.
- * <li>PRIVILEGE - The name of the privilege granted.
+ * <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
+ * <li>COLUMN_NAME - The name of the column.</li>
+ * <li>GRANTOR - The entity that granted the access.</li>
+ * <li>GRANTEE - The entity granted the access.</li>
+ * <li>PRIVILEGE - The name of the privilege granted.</li>
* <li>IS_GRANTABLE - "YES" if the grantee can grant the privilege to
- * others, "NO" if not, and <code>null</code> if unknown.
+ * others, "NO" if not, and <code>null</code> if unknown.</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
* This method returns the access rights that have been granted to the
* requested tables. This information is returned as a <code>ResultSet</code>
* with the following columns:
- * <p>
+ *
* <ol>
* <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
- * <li>GRANTOR - The entity that granted the access.
- * <li>GRANTEE - The entity granted the access.
- * <li>PRIVILEGE - The name of the privilege granted.
+ * <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
+ * <li>GRANTOR - The entity that granted the access.</li>
+ * <li>GRANTEE - The entity granted the access.</li>
+ * <li>PRIVILEGE - The name of the privilege granted.</li>
* <li>IS_GRANTABLE - "YES" if the grantee can grant the privilege to
- * others, "NO" if not, and <code>null</code> if unknown.
+ * others, "NO" if not, and <code>null</code> if unknown.</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
* This method returns the best set of columns for uniquely identifying
* a row. It returns this information as a <code>ResultSet</code> with
* the following columns:
- * <p>
+ *
* <ol>
* <li>SCOPE - The scope of the results returned. This is one of the
* constants defined in this class (<code>bestRowTemporary</code>,
- * <code>bestRowTransaction</code>, or <code>bestRowSession</code>).
- * <li>COLUMN_NAME - The name of the column.
+ * <code>bestRowTransaction</code>, or <code>bestRowSession</code>).</li>
+ * <li>COLUMN_NAME - The name of the column.</li>
* <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.
- * <li>TYPE_NAME - The string name of the data type for this column.
- * <li>COLUMN_SIZE - The precision of the columns
- * <li>BUFFER_LENGTH - Unused
- * <li>DECIMAL_DIGITS - The scale of the column.
+ * defined in <code>Types</code>.</li>
+ * <li>TYPE_NAME - The string name of the data type for this column.</li>
+ * <li>COLUMN_SIZE - The precision of the columns</li>
+ * <li>BUFFER_LENGTH - Unused</li>
+ * <li>DECIMAL_DIGITS - The scale of the column.</li>
* <li>PSEUDO_COLUMN - Whether or not the best row identifier is a
* pseudo_column. This is one of the constants defined in this class
* (<code>bestRowUnknown</code>, <code>bestRowNotPseudo</code>, or
- * <code>bestRowPseudo</code>).
+ * <code>bestRowPseudo</code>).</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
* This method returns the set of columns that are automatically updated
* when the row is update. It returns this information as a
* <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>SCOPE - Unused
- * <li>COLUMN_NAME - The name of the column.
+ * <li>SCOPE - Unused</li>
+ * <li>COLUMN_NAME - The name of the column.</li>
* <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.
- * <li>TYPE_NAME - The string name of the data type for this column.
- * <li>COLUMN_SIZE - The precision of the columns
- * <li>BUFFER_LENGTH - Unused
- * <li>DECIMAL_DIGITS - The scale of the column.
+ * defined in <code>Types</code>.</li>
+ * <li>TYPE_NAME - The string name of the data type for this column.</li>
+ * <li>COLUMN_SIZE - The precision of the columns</li>
+ * <li>BUFFER_LENGTH - Unused</li>
+ * <li>DECIMAL_DIGITS - The scale of the column.</li>
* <li>PSEUDO_COLUMN - Whether or not the best row identifier is a
* pseudo_column. This is one of the constants defined in this class
* (<code>versionRowUnknown</code>, <code>versionRowNotPseudo</code>, or
- * <code>versionRowPseudo</code>).
+ * <code>versionRowPseudo</code>).</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
/**
* This method returns a list of a table's primary key columns. These
* are returned as a <code>ResultSet</code> with the following columns.
- * <p>
+ *
* <ol>
- * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.
- * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
- * <li>COLUMN_NAME - The name of the column.
- * <li>KEY_SEQ - The sequence number of the column within the primary key.
- * <li>PK_NAME - The name of the primary key, which may be <code>null</code>.
+ * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.</li>
+ * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
+ * <li>COLUMN_NAME - The name of the column.</li>
+ * <li>KEY_SEQ - The sequence number of the column within the primary key.</li>
+ * <li>PK_NAME - The name of the primary key, which may be <code>null</code>.</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
/**
* This method returns a list of the table's foreign keys. These are
* returned as a <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.
- * <li>PKTABLE_NAME - The name of the table the key was imported from.
- * <li>PKCOLUMN_NAME - The name of the column that was imported.
- * <li>FKTABLE_CAT - The foreign key catalog name.
- * <li>FKTABLE_SCHEM - The foreign key schema name.
- * <li>FKTABLE_NAME - The foreign key table name.
- * <li>FKCOLUMN_NAME - The foreign key column name.
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.
+ * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
+ * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
+ * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
+ * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
+ * <li>FKTABLE_CAT - The foreign key catalog name.</li>
+ * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
+ * <li>FKTABLE_NAME - The foreign key table name.</li>
+ * <li>FKCOLUMN_NAME - The foreign key column name.</li>
+ * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
* <li>UPDATE_RULE - How the foreign key behaves when the primary key is
* updated. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
* <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).
+ * <code>importedKeyRestrict</code>).</li>
* <li>DELETE_RULE - How the foreign key behaves when the primary key is
* deleted. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)
- * <li>FK_NAME - The name of the foreign key.
- * <li>PK_NAME - The name of the primary key.
+ * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
+ * <li>FK_NAME - The name of the foreign key.</li>
+ * <li>PK_NAME - The name of the primary key.</li>
* <li>DEFERRABILITY - The deferrability value. This is one of the
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).
+ * <code>importedKeyNotDeferrable</code>).</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
* This method returns a list of the table's which use this table's
* primary key as a foreign key. The information is
* returned as a <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.
- * <li>PKTABLE_NAME - The name of the table the key was imported from.
- * <li>PKCOLUMN_NAME - The name of the column that was imported.
- * <li>FKTABLE_CAT - The foreign key catalog name.
- * <li>FKTABLE_SCHEM - The foreign key schema name.
- * <li>FKTABLE_NAME - The foreign key table name.
- * <li>FKCOLUMN_NAME - The foreign key column name.
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.
+ * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
+ * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
+ * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
+ * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
+ * <li>FKTABLE_CAT - The foreign key catalog name.</li>
+ * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
+ * <li>FKTABLE_NAME - The foreign key table name.</li>
+ * <li>FKCOLUMN_NAME - The foreign key column name.</li>
+ * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
* <li>UPDATE_RULE - How the foreign key behaves when the primary key is
* updated. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
* <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).
+ * <code>importedKeyRestrict</code>).</li>
* <li>DELETE_RULE - How the foreign key behaves when the primary key is
* deleted. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)
- * <li>FK_NAME - The name of the foreign key.
- * <li>PK_NAME - The name of the primary key.
+ * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
+ * <li>FK_NAME - The name of the foreign key.</li>
+ * <li>PK_NAME - The name of the primary key.</li>
* <li>DEFERRABILITY - The deferrability value. This is one of the
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).
+ * <code>importedKeyNotDeferrable</code>).</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
* This method returns a description of how one table imports another
* table's primary key as a foreign key. The information is
* returned as a <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.
- * <li>PKTABLE_NAME - The name of the table the key was imported from.
- * <li>PKCOLUMN_NAME - The name of the column that was imported.
- * <li>FKTABLE_CAT - The foreign key catalog name.
- * <li>FKTABLE_SCHEM - The foreign key schema name.
- * <li>FKTABLE_NAME - The foreign key table name.
- * <li>FKCOLUMN_NAME - The foreign key column name.
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.
+ * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
+ * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
+ * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
+ * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
+ * <li>FKTABLE_CAT - The foreign key catalog name.</li>
+ * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
+ * <li>FKTABLE_NAME - The foreign key table name.</li>
+ * <li>FKCOLUMN_NAME - The foreign key column name.</li>
+ * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
* <li>UPDATE_RULE - How the foreign key behaves when the primary key is
* updated. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
* <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).
+ * <code>importedKeyRestrict</code>).</li>
* <li>DELETE_RULE - How the foreign key behaves when the primary key is
* deleted. This is one of the constants defined in this class
* (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)
- * <li>FK_NAME - The name of the foreign key.
- * <li>PK_NAME - The name of the primary key.
+ * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
+ * <li>FK_NAME - The name of the foreign key.</li>
+ * <li>PK_NAME - The name of the primary key.</li>
* <li>DEFERRABILITY - The deferrability value. This is one of the
* constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
* <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).
+ * <code>importedKeyNotDeferrable</code>).</li>
* </ol>
*
* @param primCatalog The catalog to retrieve information from, or the empty string
* This method returns a list of the SQL types supported by this
* database. The information is returned as a <code>ResultSet</code>
* with the following columns:
- * <p>
+ *
* <ol>
- * <li>TYPE_NAME - The name of the data type.
+ * <li>TYPE_NAME - The name of the data type.</li>
* <li>DATA_TYPE - A data type constant from <code>Types</code> for this
- * type.
- * <li>PRECISION - The maximum precision of this type.
+ * type.</li>
+ * <li>PRECISION - The maximum precision of this type.</li>
* <li>LITERAL_PREFIX - Prefix value used to quote a literal, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>LITERAL_SUFFIX - Suffix value used to quote a literal, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>CREATE_PARAMS - The parameters used to create the type, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* <li>NULLABLE - Whether or not this type supports NULL values. This will
* be one of the constants defined in this interface
* (<code>typeNoNulls</code>, <code>typeNullable</code>, or
- * <code>typeNullableUnknown</code>).
- * <li>CASE_SENSITIVE - Whether or not the value is case sensitive.
+ * <code>typeNullableUnknown</code>).</li>
+ * <li>CASE_SENSITIVE - Whether or not the value is case sensitive.</li>
* <li>SEARCHABLE - Whether or not "LIKE" expressions are supported in
* WHERE clauses for this type. This will be one of the constants defined
* in this interface (<code>typePredNone</code>, <code>typePredChar</code>,
- * <code>typePredBasic</code>, or <code>typeSearchable</code>).
- * <li>UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.
- * <li>FIXED_PREC_SCALE - Whether or not this type can be used for money.
- * <li>AUTO_INCREMENT - Whether or not this type supports auto-incrementing.
- * <li>LOCAL_TYPE_NAME - A localized name for this data type.
- * <li>MINIMUM_SCALE - The minimum scale supported by this type.
- * <li>MAXIMUM_SCALE - The maximum scale supported by this type.
- * <li>SQL_DATA_TYPE - Unused.
- * <li>SQL_DATETIME_SUB - Unused.
- * <li>NUM_PREC_RADIX - The radix of this data type.
+ * <code>typePredBasic</code>, or <code>typeSearchable</code>).</li>
+ * <li>UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.</li>
+ * <li>FIXED_PREC_SCALE - Whether or not this type can be used for money.</li>
+ * <li>AUTO_INCREMENT - Whether or not this type supports auto-incrementing.</li>
+ * <li>LOCAL_TYPE_NAME - A localized name for this data type.</li>
+ * <li>MINIMUM_SCALE - The minimum scale supported by this type.</li>
+ * <li>MAXIMUM_SCALE - The maximum scale supported by this type.</li>
+ * <li>SQL_DATA_TYPE - Unused.</li>
+ * <li>SQL_DATETIME_SUB - Unused.</li>
+ * <li>NUM_PREC_RADIX - The radix of this data type.</li>
* </ol>
*
* @return A <code>ResultSet</code> with the list of available data types.
/**
* This method returns information about a tables indices and statistics.
* It is returned as a <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.
- * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.
- * <li>TABLE_NAME - The name of the table.
- * <li>NON_UNIQUE - Are index values non-unique?
- * <li>INDEX_QUALIFIER The index catalog, which may be <code>null</code>
- * <li>INDEX_NAME - The name of the index.
+ * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.</li>
+ * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.</li>
+ * <li>TABLE_NAME - The name of the table.</li>
+ * <li>NON_UNIQUE - Are index values non-unique?</li>
+ * <li>INDEX_QUALIFIER The index catalog, which may be <code>null</code></li>
+ * <li>INDEX_NAME - The name of the index.</li>
* <li>TYPE - The type of index, which will be one of the constants defined
* in this interface (<code>tableIndexStatistic</code>,
* <code>tableIndexClustered</code>, <code>tableIndexHashed</code>, or
- * <code>tableIndexOther</code>).
+ * <code>tableIndexOther</code>).</li>
* <li>ORDINAL_POSITION - The sequence number of this column in the index.
- * This will be 0 when the index type is <code>tableIndexStatistic</code>.
- * <li>COLUMN_NAME - The name of this column in the index.
+ * This will be 0 when the index type is <code>tableIndexStatistic</code>.</li>
+ * <li>COLUMN_NAME - The name of this column in the index.</li>
* <li>ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a
* descending sort sequence or <code>null</code> if a sort sequence is not
- * supported.
+ * supported.</li>
* <li>CARDINALITY - The number of unique rows in the index, or the number
- * of rows in the table if the index type is <code>tableIndexStatistic</code>.
+ * of rows in the table if the index type is <code>tableIndexStatistic</code>.</li>
* <li>PAGES - The number of pages used for the index, or the number of pages
- * in the table if the index type is <code>tableIndexStatistic</code>.
+ * in the table if the index type is <code>tableIndexStatistic</code>.</li>
* <li>FILTER_CONDITION - The filter condition for this index, which may be
- * <code>null</code>.
+ * <code>null</code>.</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
/**
* This method returns the list of user defined data types in use. These
* are returned as a <code>ResultSet</code> with the following columns:
- * <p>
+ *
* <ol>
- * <li>TYPE_CAT - The catalog name, which may be <code>null</code>.
- * <li>TYPE_SCEHM - The schema name, which may be <code>null</code>.
- * <li>TYPE_NAME - The user defined data type name.
- * <li>CLASS_NAME - The Java class name this type maps to.
+ * <li>TYPE_CAT - The catalog name, which may be <code>null</code>.</li>
+ * <li>TYPE_SCEHM - The schema name, which may be <code>null</code>.</li>
+ * <li>TYPE_NAME - The user defined data type name.</li>
+ * <li>CLASS_NAME - The Java class name this type maps to.</li>
* <li>DATA_TYPE - A type identifier from <code>Types</code> for this type.
* This will be one of <code>JAVA_OBJECT</code>, <code>STRUCT</code>, or
- * <code>DISTINCT</code>.
- * <li>REMARKS - Comments about this data type.
+ * <code>DISTINCT</code>.</li>
+ * <li>REMARKS - Comments about this data type.</li>
* </ol>
*
* @param catalog The catalog to retrieve information from, or the empty string
/**
* This interface provides access to the data set returned by a SQL
* statement. An instance of this interface is returned by the various
- * execution methods in the <code>Statement</code.
- * <p>
- * This class models a cursor, which can be stepped through one row at a
+ * execution methods in the <code>Statement</code>.
+ *
+ * <p> This class models a cursor, which can be stepped through one row at a
* time. Methods are provided for accessing columns by column name or by
- * index.
- * <p>
- * Note that a result set is invalidated if the statement that returned
- * it is closed.
+ * index.</p>
+ *
+ * <p> Note that a result set is invalidated if the statement that returned
+ * it is closed.</p>
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
* To use this class, first specify two lists of formats and range terminators.
* These lists must be arrays of equal length. The format of index
* <code>i</code> will be selected for value <code>X</code> if
- * <code>terminator[i] <= X < limit[i + 1]</code>. If the value X is not
+ * <code>terminator[i] <= X < limit[i + 1]</code>. If the value X is not
* included in any range, then either the first or last format will be
* used depending on whether the value X falls outside the range.
* <p>
* This method tests this object for equality with the specified
* object. This will be true if and only if:
* <ul>
- * <li>The specified object is not <code>null</code>.
- * <li>The specified object is an instance of <code>ChoiceFormat</code>.
+ * <li>The specified object is not <code>null</code>.</li>
+ * <li>The specified object is an instance of <code>ChoiceFormat</code>.</li>
* <li>The termination ranges and format strings are identical to
- * this object's.
+ * this object's. </li>
* </ul>
*
* @param obj The object to test for equality against.
/**
* This method resets the internal position pointer to read from the
- * beginning of the <code>String again.
+ * beginning of the <code>String</code> again.
*/
public void reset()
{
* this object. This will be true if and only if:
* <p>
* <ul>
- * <li>The specified object must not be <code>null</code>
- * <li>The specified object is an instance of <code>CollationKey</code>.
+ * <li>The specified object must not be <code>null</code></li>
+ * <li>The specified object is an instance of <code>CollationKey</code>.</li>
* <li>The specified object was created from the same <code>Collator</code>
- * as this object.
+ * as this object.</li>
* <li>The specified object has the same source string and bit key as
- * this object.
+ * this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality.
* object. This will be true if and only if the following conditions are
* met:
* <ul>
- * <li>The specified object is not <code>null</code>.
- * <li>The specified object is an instance of <code>Collator</code>.
+ * <li>The specified object is not <code>null</code>.</li>
+ * <li>The specified object is an instance of <code>Collator</code>.</li>
* <li>The specified object has the same strength and decomposition
- * settings as this object.
+ * settings as this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against
* object:
* <P>
* <ul>
- * <li>Is not <code>null</code>.
- * <li>Is an instance of <code>DateFormat</code>.
- * <li>Has the same numberFormat field value as this object.
+ * <li>Is not <code>null</code>.</li>
+ * <li>Is an instance of <code>DateFormat</code>.</li>
+ * <li>Has the same numberFormat field value as this object.</li>
* </ul>
*
* @param obj The object to test for equality against.
* the array contains five values:
* <P>
* <ul>
- * <li>0 - The non-localized time zone id string.
- * <li>1 - The long name of the time zone (standard time).
- * <li>2 - The short name of the time zone (standard time).
- * <li>3 - The long name of the time zone (daylight savings time).
- * <li>4 - the short name of the time zone (daylight savings time).
+ * <li>0 - The non-localized time zone id string.</li>
+ * <li>1 - The long name of the time zone (standard time).</li>
+ * <li>2 - The short name of the time zone (standard time).</li>
+ * <li>3 - The long name of the time zone (daylight savings time).</li>
+ * <li>4 - the short name of the time zone (daylight savings time).</li>
+ * </ul>
*
* @return The list of time zone display strings.
*/
* the array contains five values:
* <P>
* <ul>
- * <li>0 - The non-localized time zone id string.
- * <li>1 - The long name of the time zone (standard time).
- * <li>2 - The short name of the time zone (standard time).
- * <li>3 - The long name of the time zone (daylight savings time).
- * <li>4 - the short name of the time zone (daylight savings time).
+ * <li>0 - The non-localized time zone id string.</li>
+ * <li>1 - The long name of the time zone (standard time).</li>
+ * <li>2 - The short name of the time zone (standard time).</li>
+ * <li>3 - The long name of the time zone (daylight savings time).</li>
+ * <li>4 - the short name of the time zone (daylight savings time).</li>
+ * </ul>
*
* @return The list of time zone display strings.
*/
* This will be true if and only if the specified object:
* <p>
* <ul>
- * <li> Is not <code>null</code>.
- * <li> Is an instance of <code>DateFormatSymbols</code>.
- * <li> Contains identical formatting symbols to this object.
+ * <li> Is not <code>null</code>.</li>
+ * <li> Is an instance of <code>DateFormatSymbols</code>.</li>
+ * <li> Contains identical formatting symbols to this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against.
*
* @return <code>true</code> if the specified object is equal to this one,
- * </code>false</code> otherwise.
+ * <code>false</code> otherwise.
*/
public boolean equals (Object obj)
{
* regard to the specified object:
* <p>
* <ul>
- * <li>It is not <code>null</code>.
- * <li>It is an instance of <code>DecimalFormatSymbols</code>
- * <li>All of its symbols are identical to the symbols in this object.
+ * <li>It is not <code>null</code>.</li>
+ * <li>It is an instance of <code>DecimalFormatSymbols</code>.</li>
+ * <li>All of its symbols are identical to the symbols in this object.</li>
* </ul>
*
* @return <code>true</code> if the specified object is equal to this
* This method parses a <code>String</code> and converts the parsed
* contents into an <code>Object</code>.
*
- * @param str The <code>String to parse.
+ * @param str The <code>String</code> to parse.
*
* @return The resulting <code>Object</code>.
*
* all of the following conditions are met.
* <p>
* <ul>
- * <li>The specified object is not <code>null</code>.
- * <li>The specified object is an instance of <code>ParsePosition</code>.
+ * <li>The specified object is not <code>null</code>.</li>
+ * <li>The specified object is an instance of <code>ParsePosition</code>.</li>
* <li>The specified object has the same index and error index as
- * this object.
+ * this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against
* <p>
* Rules take the form of a <code>String</code> with the following syntax
* <ul>
- * <li> Modifier: '@'
- * <li> Relation: '<' | ';' | ',' | '=' : <text>
- * <li> Reset: '&' : <text>
+ * <li> Modifier: '@'</li>
+ * <li> Relation: '<' | ';' | ',' | '=' : <text></li>
+ * <li> Reset: '&' : <text></li>
* </ul>
* The modifier character indicates that accents sort backward as is the
* case with French. The modifier applies to all rules <b>after</b>
* the following meanings:
* <ul>
* <li>'<' - The text argument is greater than the prior term at the primary
- * difference level.
+ * difference level.</li>
* <li>';' - The text argument is greater than the prior term at the secondary
- * difference level.
+ * difference level.</li>
* <li>',' - The text argument is greater than the prior term at the tertiary
- * difference level.
- * <li>'=' - The text argument is equal to the prior term
+ * difference level.</li>
+ * <li>'=' - The text argument is equal to the prior term</li>
* </ul>
* <p>
* As for the text argument itself, this is any sequence of Unicode
* A <code>ParseException</code> will be thrown for any of the following
* conditions:
* <ul>
- * <li>Unquoted punctuation characters in a text argument.
- * <li>A relational or reset operator not followed by a text argument
+ * <li>Unquoted punctuation characters in a text argument.</li>
+ * <li>A relational or reset operator not followed by a text argument</li>
* <li>A reset operator where the text argument is not present in
- * the previous rule string section.
+ * the previous rule string section.</li>
* </ul>
*
- * @author Aaron M. Renn <arenn@urbanophile.com>
- * @author Tom Tromey <tromey@cygnus.com>
- * @author Guilhem Lavaux <guilhem@kaffe.org>
+ * @author Aaron M. Renn (arenn@urbanophile.com)
+ * @author Tom Tromey (tromey@cygnus.com)
+ * @author Guilhem Lavaux (guilhem@kaffe.org)
*/
public class RuleBasedCollator extends Collator
{
* object. This will be true if and only if the specified object:
* <p>
* <ul>
- * <li>Is not <code>null</code>.
- * <li>Is an instance of <code>SimpleDateFormat</code>.
+ * <li>Is not <code>null</code>.</li>
+ * <li>Is an instance of <code>SimpleDateFormat</code>.</li>
* <li>Is equal to this object at the superclass (i.e., <code>DateFormat</code>)
- * level.
- * <li>Has the same formatting pattern.
- * <li>Is using the same formatting symbols.
- * <li>Is using the same century for two digit years.
+ * level.</li>
+ * <li>Has the same formatting pattern.</li>
+ * <li>Is using the same formatting symbols.</li>
+ * <li>Is using the same century for two digit years.</li>
* </ul>
*
* @param obj The object to compare for equality against.
* object. This will be true if and only if the specified object:
* <p>
* <ul>
- * <li>is not <code>null</code>.
- * <li>is an instance of <code>StringCharacterIterator</code>
- * <li>has the same text as this object
- * <li>has the same beginning, ending, and current index as this object.
+ * <li>is not <code>null</code>.</li>
+ * <li>is an instance of <code>StringCharacterIterator</code></li>
+ * <li>has the same text as this object</li>
+ * <li>has the same beginning, ending, and current index as this object.</li>
* </ul>
*
* @param obj The object to test for equality against.
* are not required, to throw the {@link UnsupportedOperationException} that
* the underlying collection would throw during an attempt at modification.
* For example,
- * <code>Collections.singleton("").addAll(Collections.EMPTY_SET)<code>
+ * <code>Collections.singleton("").addAll(Collections.EMPTY_SET)</code>
* does not throw a exception, even though addAll is an unsupported operation
* on a singleton; the reason for this is that addAll did not attempt to
* modify the set.
*
* If there is also a class for this resource and the same locale, the
* class will be chosen. The properties file should have the name of the
- * resource bundle, appended with the locale (e.g. <code>_de</code) and the
+ * resource bundle, appended with the locale (e.g. <code>_de</code> and the
* extension <code>.properties</code>. The file should have the same format
* as for <code>Properties.load()</code>
*
* <code>getObject</code> or <code>getString</code> on that bundle.
*
* <p>When a bundle is demanded for a specific locale, the ResourceBundle
- * is searched in following order (<i>def. language<i> stands for the
+ * is searched in following order (<i>def. language</i> stands for the
* two letter ISO language code of the default locale (see
* <code>Locale.getDefault()</code>).
*
*
* <p>A sequence of candidate bundle names are generated, and tested in
* this order, where the suffix 1 means the string from the specified
- * locale, and the suffix 2 means the string from the default locale:<ul>
+ * locale, and the suffix 2 means the string from the default locale:</p>
+ *
+ * <ul>
* <li>baseName + "_" + language1 + "_" + country1 + "_" + variant1</li>
* <li>baseName + "_" + language1 + "_" + country1</li>
* <li>baseName + "_" + language1</li>
* <li>baseName + "_" + language2 + "_" + country2 + "_" + variant2</li>
* <li>baseName + "_" + language2 + "_" + country2</li>
- * <li>baseName + "_" + language2<li>
+ * <li>baseName + "_" + language2</li>
* <li>baseName</li>
* </ul>
*
* <p>In the sequence, entries with an empty string are ignored. Next,
- * <code>getBundle</code> tries to instantiate the resource bundle:<ul>
+ * <code>getBundle</code> tries to instantiate the resource bundle:</p>
+ *
+ * <ul>
* <li>First, an attempt is made to load a class in the specified classloader
* which is a subclass of ResourceBundle, and which has a public constructor
* with no arguments, via reflection.</li>
* in the above sequence are tested in a similar manner, and if any results
* in a resource bundle, it is assigned as the parent of the first bundle
* using the <code>setParent</code> method (unless the first bundle already
- * has a parent).
+ * has a parent).</p>
*
* <p>For example, suppose the following class and property files are
* provided: MyResources.class, MyResources_fr_CH.properties,
* all files are valid (that is, public non-abstract subclasses of
* ResourceBundle with public nullary constructors for the ".class" files,
* syntactically correct ".properties" files). The default locale is
- * Locale("en", "UK").
+ * Locale("en", "UK").</p>
*
* <p>Calling getBundle with the shown locale argument values instantiates
- * resource bundles from the following sources:<ul>
+ * resource bundles from the following sources:</p>
+ *
+ * <ul>
* <li>Locale("fr", "CH"): result MyResources_fr_CH.class, parent
* MyResources_fr.properties, parent MyResources.class</li>
* <li>Locale("fr", "FR"): result MyResources_fr.properties, parent
* <li>Locale("es", "ES"): result MyResources_es_ES.class, parent
* MyResources.class</li>
* </ul>
- * The file MyResources_fr_CH.properties is never used because it is hidden
- * by MyResources_fr_CH.class.
+ *
+ * <p>The file MyResources_fr_CH.properties is never used because it is hidden
+ * by MyResources_fr_CH.class.</p>
*
* @param baseName the name of the ResourceBundle
* @param locale A locale
/**
* This does the same as hasMoreTokens. This is the
- * <code>Enumeration</code interface method.
+ * <code>Enumeration</code> interface method.
*
* @return true, if the next call of nextElement() will succeed
* @see #hasMoreTokens()
/**
* This does the same as nextTokens. This is the
- * <code>Enumeration</code interface method.
+ * <code>Enumeration</code> interface method.
*
* @return the next token with respect to the current delimiter characters
* @throws NoSuchElementException if there are no more tokens
* attributes, applet attributes, extension identification attributes,
* package versioning and sealing attributes, file contents attributes,
* bean objects attribute and signing attributes. See the
- * <p>
- * The characters of a Name must obey the following restrictions:
+ *
+ * <p>The characters of a Name must obey the following restrictions:</p>
+ *
* <ul>
- * <li> Must contain at least one character
- * <li> The first character must be alphanumeric (a-z, A-Z, 0-9)
- * <li> All other characters must be alphanumeric, a '-' or a '_'
+ * <li>Must contain at least one character</li>
+ * <li>The first character must be alphanumeric (a-z, A-Z, 0-9)</li>
+ * <li>All other characters must be alphanumeric, a '-' or a '_'</li>
* </ul>
- * <p>
- * When comparing Names (with <code>equals</code>) all characters are
+ *
+ * <p>When comparing Names (with <code>equals</code>) all characters are
* converted to lowercase. But you can get the original case sensitive
- * string with the <code>toString()</code> method.
+ * string with the <code>toString()</code> method.</p>
*
* @since 1.2
* @author Mark Wielaard (mark@klomp.org)
* Manifest manifest file with the following Names:
* <ul>
* <li> <extension>-Extension-Name:
- * unique name of the extension
+ * unique name of the extension</li>
* <li> <extension>-Specification-Version:
- * minimum specification version
+ * minimum specification version</li>
* <li> <extension>-Implementation-Version:
- * minimum implementation version
+ * minimum implementation version</li>
* <li> <extension>-Implementation-Vendor-Id:
- * unique id of implementation vendor
+ * unique id of implementation vendor</li>
* <li> <extension>-Implementation-URL:
- * where the latest version of the extension library can be found
+ * where the latest version of the extension library can be found</li>
* </ul>
*/
public static final Name EXTENSION_LIST = new Name("Extension-List");
*
* <li><code>java.util.logging.ConsoleHandler.encoding</code> - specifies
* the name of the character encoding. Default value:
- * the default platform encoding.
+ * the default platform encoding.</li>
*
* </ul>
*
* <code>java.util.logging.LogManager</code> is initialized.
* The configuration process includes the subsequent steps:
*
- * <ol>
+ * <ul>
* <li>If the system property <code>java.util.logging.manager</code>
* is set to the name of a subclass of
* <code>java.util.logging.LogManager</code>, an instance of
* that subclass is created and becomes the global LogManager.
* Otherwise, a new instance of LogManager is created.</li>
- *
* <li>The <code>LogManager</code> constructor tries to create
* a new instance of the class specified by the system
* property <code>java.util.logging.config.class</code>.
* {@link #readConfiguration(java.io.InputStream)}.
* The name and location of this file are specified by the system
* property <code>java.util.logging.config.file</code>.</li>
- *
* <li>If the system property <code>java.util.logging.config.file</code>
* is not set, however, the contents of the URL
* "{gnu.classpath.home.url}/logging.properties" are passed to
* {@link #readConfiguration(java.io.InputStream)}.
* Here, "{gnu.classpath.home.url}" stands for the value of
* the system property <code>gnu.classpath.home.url</code>.</li>
- * </ol>
+ * </ul>
*
* @author Sascha Brawer (brawer@acm.org)
*/
*
* @param logger the logger to be added.
*
- * @return <code>true<code>if <code>logger</code> was added,
+ * @return <code>true</code>if <code>logger</code> was added,
* <code>false</code> otherwise.
*
- * @throws NullPointerException if <code>name<code> is
+ * @throws NullPointerException if <code>name</code> is
* <code>null</code>.
*/
public synchronized boolean addLogger(Logger logger)
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
-exception statement from your version.
-
-*/
-
+exception statement from your version. */
package java.util.logging;
* value, a default is taken without an exception being thrown.
*
* <ul>
- *
* <li><code>java.util.MemoryHandler.level</code> - specifies
* the initial severity level threshold. Default value:
* <code>Level.ALL</code>.</li>
- *
* <li><code>java.util.MemoryHandler.filter</code> - specifies
* the name of a Filter class. Default value: No Filter.</li>
- *
* <li><code>java.util.MemoryHandler.size</code> - specifies the
* maximum number of log records that are kept in the circular
* buffer. Default value: 1000.</li>
- *
* <li><code>java.util.MemoryHandler.push</code> - specifies the
* <code>pushLevel</code>. Default value:
* <code>Level.SEVERE</code>.</li>
- *
* <li><code>java.util.MemoryHandler.target</code> - specifies the
* name of a subclass of {@link Handler} that will be used as the
* target handler. There is no default value for this property;
* if it is not set, the no-argument MemoryHandler constructor
* will throw an exception.</li>
- *
* </ul>
*
* @author Sascha Brawer (brawer@acm.org)
*
* <li><code>java.util.SocketHandler.encoding</code> - specifies
* the name of the character encoding. Default value:
- * the default platform encoding.
+ * the default platform encoding.</li>
*
* <li><code>java.util.SocketHandler.host</code> - specifies
* the name of the host to which records are published.
/**
* Creates a new NamingException without a message. Does not set any of the
* <code>rootException</code>, <code>resolvedName</code>,
- * <code>resolvedObj</code> or <code>remainingObject,<code> fields.
+ * <code>resolvedObj</code> or <code>remainingObject</code> fields.
* These fields can be set later.
*/
public NamingException ()
/**
* Creates a new NamingException with a detailed message. Does not set
* the <code>rootException</code>, <code>resolvedName</code>,
- * <code>resolvedObj</code> or <code>remainingObject,<code> fields.
+ * <code>resolvedObj</code> or <code>remainingObject,</code> fields.
* These fields can be set later.
*/
public NamingException (String msg)
OSDN Git Service
