changeset 8029:be0bcd6a904e

8024432: Fix doclint issues in java.security Reviewed-by: darcy, mullan
author juh
date Mon, 09 Sep 2013 10:52:56 -0700
parents 4fd7abaf0a5f
children 6731ea9123f2
files src/share/classes/java/security/AccessController.java src/share/classes/java/security/AlgorithmParameters.java src/share/classes/java/security/AlgorithmParametersSpi.java src/share/classes/java/security/KeyFactory.java src/share/classes/java/security/KeyFactorySpi.java src/share/classes/java/security/KeyStore.java src/share/classes/java/security/Principal.java src/share/classes/java/security/cert/CertPathBuilderSpi.java src/share/classes/java/security/cert/CertPathValidatorSpi.java src/share/classes/java/security/cert/PKIXRevocationChecker.java src/share/classes/java/security/interfaces/RSAMultiPrimePrivateCrtKey.java src/share/classes/java/security/interfaces/RSAPrivateCrtKey.java src/share/classes/java/security/interfaces/RSAPrivateKey.java src/share/classes/java/security/interfaces/RSAPublicKey.java
diffstat 14 files changed, 65 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/java/security/AccessController.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/AccessController.java	Mon Sep 09 10:52:56 2013 -0700
@@ -279,6 +279,9 @@
      * <p> Note that any DomainCombiner associated with the current
      * AccessControlContext will be ignored while the action is performed.
      *
+     * @param <T> the type of the value returned by the PrivilegedAction's
+     *                  {@code run} method.
+     *
      * @param action the action to be performed.
      *
      * @return the value returned by the action's {@code run} method.
@@ -305,6 +308,9 @@
      * <p> This method preserves the current AccessControlContext's
      * DomainCombiner (which may be null) while the action is performed.
      *
+     * @param <T> the type of the value returned by the PrivilegedAction's
+     *                  {@code run} method.
+     *
      * @param action the action to be performed.
      *
      * @return the value returned by the action's {@code run} method.
@@ -344,6 +350,8 @@
      * {@link java.security.SecurityPermission}, then the action is performed
      * with no permissions.
      *
+     * @param <T> the type of the value returned by the PrivilegedAction's
+     *                  {@code run} method.
      * @param action the action to be performed.
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
@@ -377,6 +385,8 @@
      * If the action's {@code run} method throws an (unchecked) exception,
      * it will propagate through this method.
      *
+     * @param <T> the type of the value returned by the PrivilegedAction's
+     *                  {@code run} method.
      * @param action the action to be performed.
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
@@ -429,6 +439,8 @@
      * <p> This method preserves the current AccessControlContext's
      * DomainCombiner (which may be null) while the action is performed.
      *
+     * @param <T> the type of the value returned by the PrivilegedAction's
+     *                  {@code run} method.
      * @param action the action to be performed.
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
@@ -479,6 +491,9 @@
      * <p> Note that any DomainCombiner associated with the current
      * AccessControlContext will be ignored while the action is performed.
      *
+     * @param <T> the type of the value returned by the
+     *                  PrivilegedExceptionAction's {@code run} method.
+     *
      * @param action the action to be performed
      *
      * @return the value returned by the action's {@code run} method
@@ -509,6 +524,9 @@
      * <p> This method preserves the current AccessControlContext's
      * DomainCombiner (which may be null) while the action is performed.
      *
+     * @param <T> the type of the value returned by the
+     *                  PrivilegedExceptionAction's {@code run} method.
+     *
      * @param action the action to be performed.
      *
      * @return the value returned by the action's {@code run} method
@@ -585,6 +603,8 @@
      * {@link java.security.SecurityPermission}, then the action is performed
      * with no permissions.
      *
+     * @param <T> the type of the value returned by the
+     *                  PrivilegedExceptionAction's {@code run} method.
      * @param action the action to be performed
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
@@ -622,6 +642,8 @@
      * If the action's {@code run} method throws an (unchecked) exception,
      * it will propagate through this method.
      *
+     * @param <T> the type of the value returned by the
+     *                  PrivilegedExceptionAction's {@code run} method.
      * @param action the action to be performed.
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
@@ -676,6 +698,8 @@
      * <p> This method preserves the current AccessControlContext's
      * DomainCombiner (which may be null) while the action is performed.
      *
+     * @param <T> the type of the value returned by the
+     *                  PrivilegedExceptionAction's {@code run} method.
      * @param action the action to be performed.
      * @param context an <i>access control context</i>
      *                representing the restriction to be applied to the
--- a/src/share/classes/java/security/AlgorithmParameters.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/AlgorithmParameters.java	Mon Sep 09 10:52:56 2013 -0700
@@ -324,6 +324,7 @@
      * parameters should be returned in an instance of the
      * {@code DSAParameterSpec} class.
      *
+     * @param <T> the type of the parameter specification to be returrned
      * @param paramSpec the specification class in which
      * the parameters should be returned.
      *
--- a/src/share/classes/java/security/AlgorithmParametersSpi.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/AlgorithmParametersSpi.java	Mon Sep 09 10:52:56 2013 -0700
@@ -102,6 +102,8 @@
      * parameters should be returned in an instance of the
      * {@code DSAParameterSpec} class.
      *
+     * @param <T> the type of the parameter specification to be returned
+     *
      * @param paramSpec the specification class in which
      * the parameters should be returned.
      *
--- a/src/share/classes/java/security/KeyFactory.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/KeyFactory.java	Mon Sep 09 10:52:56 2013 -0700
@@ -395,6 +395,8 @@
      * key material should be returned in an instance of the
      * {@code DSAPublicKeySpec} class.
      *
+     * @param <T> the type of the key specification to be returned
+     *
      * @param key the key.
      *
      * @param keySpec the specification class in which
--- a/src/share/classes/java/security/KeyFactorySpi.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/KeyFactorySpi.java	Mon Sep 09 10:52:56 2013 -0700
@@ -106,6 +106,8 @@
      * key material should be returned in an instance of the
      * {@code DSAPublicKeySpec} class.
      *
+     * @param <T> the type of the key specification to be returned
+     *
      * @param key the key.
      *
      * @param keySpec the specification class in which
--- a/src/share/classes/java/security/KeyStore.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/KeyStore.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1753,6 +1753,7 @@
         /**
          * Returns the KeyStore described by this object.
          *
+         * @return the {@code KeyStore} described by this object
          * @exception KeyStoreException if an error occured during the
          *   operation, for example if the KeyStore could not be
          *   instantiated or loaded
--- a/src/share/classes/java/security/Principal.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/Principal.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1996, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -81,6 +81,7 @@
      * <p>Subclasses may override this with a different implementation, if
      * necessary.
      *
+     * @param subject the {@code Subject}
      * @return true if {@code subject} is non-null and is
      *              implied by this principal, or false otherwise.
      * @since 1.8
--- a/src/share/classes/java/security/cert/CertPathBuilderSpi.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/cert/CertPathBuilderSpi.java	Mon Sep 09 10:52:56 2013 -0700
@@ -87,6 +87,8 @@
      * service providers, this method cannot be abstract and by default throws
      * an {@code UnsupportedOperationException}.
      *
+     * @return a {@code CertPathChecker} that this implementation uses to
+     * check the revocation status of certificates
      * @throws UnsupportedOperationException if this method is not supported
      * @since 1.8
      */
--- a/src/share/classes/java/security/cert/CertPathValidatorSpi.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/cert/CertPathValidatorSpi.java	Mon Sep 09 10:52:56 2013 -0700
@@ -97,6 +97,8 @@
      * service providers, this method cannot be abstract and by default throws
      * an {@code UnsupportedOperationException}.
      *
+     * @return a {@code CertPathChecker} that this implementation uses to
+     * check the revocation status of certificates
      * @throws UnsupportedOperationException if this method is not supported
      * @since 1.8
      */
--- a/src/share/classes/java/security/cert/PKIXRevocationChecker.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/cert/PKIXRevocationChecker.java	Mon Sep 09 10:52:56 2013 -0700
@@ -103,6 +103,9 @@
     private Map<X509Certificate, byte[]> ocspResponses = Collections.emptyMap();
     private Set<Option> options = Collections.emptySet();
 
+    /**
+     * Default constructor.
+     */
     protected PKIXRevocationChecker() {}
 
     /**
--- a/src/share/classes/java/security/interfaces/RSAMultiPrimePrivateCrtKey.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/interfaces/RSAMultiPrimePrivateCrtKey.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -46,6 +46,11 @@
 
 public interface RSAMultiPrimePrivateCrtKey extends RSAPrivateKey {
 
+    /**
+     * The type fingerprint that is set to indicate
+     * serialization compatibility with a previous
+     * version of the type.
+     */
     static final long serialVersionUID = 618058533534628008L;
 
     /**
--- a/src/share/classes/java/security/interfaces/RSAPrivateCrtKey.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/interfaces/RSAPrivateCrtKey.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -39,6 +39,11 @@
 
 public interface RSAPrivateCrtKey extends RSAPrivateKey {
 
+    /**
+     * The type fingerprint that is set to indicate
+     * serialization compatibility with a previous
+     * version of the type.
+     */
     static final long serialVersionUID = -5682214253527700368L;
 
     /**
--- a/src/share/classes/java/security/interfaces/RSAPrivateKey.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/interfaces/RSAPrivateKey.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -39,6 +39,11 @@
 public interface RSAPrivateKey extends java.security.PrivateKey, RSAKey
 {
 
+    /**
+     * The type fingerprint that is set to indicate
+     * serialization compatibility with a previous
+     * version of the type.
+     */
     static final long serialVersionUID = 5187144804936595022L;
 
     /**
--- a/src/share/classes/java/security/interfaces/RSAPublicKey.java	Mon Sep 09 13:44:30 2013 +0100
+++ b/src/share/classes/java/security/interfaces/RSAPublicKey.java	Mon Sep 09 10:52:56 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -36,6 +36,11 @@
 
 public interface RSAPublicKey extends java.security.PublicKey, RSAKey
 {
+    /**
+     * The type fingerprint that is set to indicate
+     * serialization compatibility with a previous
+     * version of the type.
+     */
     static final long serialVersionUID = -8727434096241101194L;
 
     /**