MarshalledObject.java, [...]: Fixed javadoc, coding style and argument names all over.

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. From-SVN: r80906
2004-04-20 14:45:10 +00:00
parent 386d3a1616
commit a17c9f2ea1
46 changed files with 441 additions and 386 deletions
@@ -1,5 +1,5 @@
 /* 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.

@@ -91,7 +91,7 @@ public final class AccessController
   *
   * @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)
  {
@@ -110,7 +110,7 @@ public final class AccessController
   * 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)
@@ -130,7 +130,7 @@ public final class AccessController
   *
   * @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.
   */
@@ -162,7 +162,7 @@ public final class AccessController
   * <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.
   */
@@ -67,7 +67,7 @@ import gnu.java.security.Engine;
 *  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>
@@ -71,7 +71,7 @@ import gnu.java.security.Engine;
 * 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>
 *
@@ -159,17 +159,22 @@ public class CodeSource implements Serializable
   * 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
@@ -183,19 +188,21 @@ public class CodeSource implements Serializable
   *             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
@@ -245,7 +252,7 @@ public class CodeSource implements Serializable
  /**
   * 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 "&lt;no certificates&gt;"),
   * followed by <code>")"</code>.
   *
   * @return a <code>String</code> for this object
@@ -151,7 +151,7 @@ public abstract class Identity implements Principal, Serializable
   * @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)
@@ -123,7 +123,7 @@ public abstract class IdentityScope extends Identity
  }

  /**
-   * <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
@@ -131,7 +131,7 @@ public abstract class IdentityScope extends Identity
   *
   * @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)
@@ -56,43 +56,42 @@ import gnu.java.security.Engine;
 * 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
@@ -208,7 +208,7 @@ public class KeyStore

  /**
   * Returns the default KeyStore type. This method looks up the
-   * type in <JAVA_HOME>/lib/security/java.security with the 
+   * type in &lt;JAVA_HOME&gt;/lib/security/java.security with the 
   * property "keystore.type" or if that fails then "jks" .
   */
  public static final String getDefaultType()
@@ -1,5 +1,5 @@
 /* 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.

@@ -59,7 +59,7 @@ import java.util.Vector;
 *
 * @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.";

@@ -670,7 +670,7 @@ public final class Security extends Object
    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
@@ -83,20 +83,20 @@ import gnu.java.security.Engine;
 * either signing data or verifying a signature:</p>
 *
 * <ol>
- *    <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>
+ * <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
@@ -105,7 +105,7 @@ import gnu.java.security.Engine;
 * 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
 {
@@ -279,7 +279,7 @@ public abstract class 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
@@ -98,7 +98,7 @@ import java.io.Serializable;
 * <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,
@@ -1,5 +1,5 @@
 /* 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.

@@ -48,7 +48,7 @@ import java.math.BigInteger;

 	@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;
@@ -1,5 +1,5 @@
 /* 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.

@@ -47,7 +47,7 @@ import java.math.BigInteger;

 	@author Mark Benvenuto
 */
-public class DSAPrivateKeySpec extends Object implements KeySpec 
+public class DSAPrivateKeySpec implements KeySpec 
 {
  private BigInteger x = null;
  private BigInteger p = null;
@@ -1,5 +1,5 @@
 /* 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.

@@ -47,7 +47,7 @@ import java.math.BigInteger;

 	@author Mark Benvenuto
 */
-public class DSAPublicKeySpec extends Object implements KeySpec 
+public class DSAPublicKeySpec implements KeySpec 
 {
  private BigInteger y = null;
  private BigInteger p = null;