提交 4bf8cc29 编写于 作者: J juh

8019772: Fix doclint issues in javax.crypto and javax.security subpackages

Reviewed-by: darcy
上级 2a659c5d
...@@ -1135,7 +1135,7 @@ public class Cipher { ...@@ -1135,7 +1135,7 @@ public class Cipher {
* *
* <p>If this cipher (including its underlying feedback or padding scheme) * <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get * requires any random bytes (e.g., for parameter generation), it will get
* them using the {@link SecureRandom <code>SecureRandom</code>} * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority * implementation of the highest-priority
* installed provider as the source of randomness. * installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
...@@ -1263,7 +1263,7 @@ public class Cipher { ...@@ -1263,7 +1263,7 @@ public class Cipher {
* *
* <p>If this cipher (including its underlying feedback or padding scheme) * <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get * requires any random bytes (e.g., for parameter generation), it will get
* them using the {@link SecureRandom <code>SecureRandom</code>} * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority * implementation of the highest-priority
* installed provider as the source of randomness. * installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
...@@ -1400,7 +1400,7 @@ public class Cipher { ...@@ -1400,7 +1400,7 @@ public class Cipher {
* *
* <p>If this cipher (including its underlying feedback or padding scheme) * <p>If this cipher (including its underlying feedback or padding scheme)
* requires any random bytes (e.g., for parameter generation), it will get * requires any random bytes (e.g., for parameter generation), it will get
* them using the {@link SecureRandom <code>SecureRandom</code>} * them using the {@link java.security.SecureRandom}
* implementation of the highest-priority * implementation of the highest-priority
* installed provider as the source of randomness. * installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
......
...@@ -245,7 +245,7 @@ public class CipherInputStream extends FilterInputStream { ...@@ -245,7 +245,7 @@ public class CipherInputStream extends FilterInputStream {
* <p>Fewer bytes than requested might be skipped. * <p>Fewer bytes than requested might be skipped.
* The actual number of bytes skipped is equal to <code>n</code> or * The actual number of bytes skipped is equal to <code>n</code> or
* the result of a call to * the result of a call to
* {@link #available() <code>available</code>}, * {@link #available() available},
* whichever is smaller. * whichever is smaller.
* If <code>n</code> is less than zero, no bytes are skipped. * If <code>n</code> is less than zero, no bytes are skipped.
* *
......
/* /*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -116,7 +116,7 @@ public class ExemptionMechanism { ...@@ -116,7 +116,7 @@ public class ExemptionMechanism {
* mechanism. * mechanism.
* See the ExemptionMechanism section in the * See the ExemptionMechanism section in the
* <a href= * <a href=
* "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a> * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names. * for information about standard exemption mechanism names.
* *
...@@ -155,7 +155,7 @@ public class ExemptionMechanism { ...@@ -155,7 +155,7 @@ public class ExemptionMechanism {
* @param algorithm the standard name of the requested exemption mechanism. * @param algorithm the standard name of the requested exemption mechanism.
* See the ExemptionMechanism section in the * See the ExemptionMechanism section in the
* <a href= * <a href=
* "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a> * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names. * for information about standard exemption mechanism names.
* *
...@@ -199,7 +199,7 @@ public class ExemptionMechanism { ...@@ -199,7 +199,7 @@ public class ExemptionMechanism {
* @param algorithm the standard name of the requested exemption mechanism. * @param algorithm the standard name of the requested exemption mechanism.
* See the ExemptionMechanism section in the * See the ExemptionMechanism section in the
* <a href= * <a href=
* "{docRoot}/../technotes/guides/security/StandardNames.html#Exemption"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#Exemption">
* Java Cryptography Architecture Standard Algorithm Name Documentation</a> * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard exemption mechanism names. * for information about standard exemption mechanism names.
* *
......
/* /*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -149,7 +149,7 @@ public class KeyAgreement { ...@@ -149,7 +149,7 @@ public class KeyAgreement {
* algorithm. * algorithm.
* See the KeyAgreement section in the <a href= * See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
* Java Cryptography Architecture Standard Algorithm Name Documentation * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names. * for information about standard algorithm names.
* *
* @return the new <code>KeyAgreement</code> object. * @return the new <code>KeyAgreement</code> object.
...@@ -196,7 +196,7 @@ public class KeyAgreement { ...@@ -196,7 +196,7 @@ public class KeyAgreement {
* algorithm. * algorithm.
* See the KeyAgreement section in the <a href= * See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
* Java Cryptography Architecture Standard Algorithm Name Documentation * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names. * for information about standard algorithm names.
* *
* @param provider the name of the provider. * @param provider the name of the provider.
...@@ -240,7 +240,7 @@ public class KeyAgreement { ...@@ -240,7 +240,7 @@ public class KeyAgreement {
* algorithm. * algorithm.
* See the KeyAgreement section in the <a href= * See the KeyAgreement section in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement"> * "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
* Java Cryptography Architecture Standard Algorithm Name Documentation * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names. * for information about standard algorithm names.
* *
* @param provider the provider. * @param provider the provider.
...@@ -418,7 +418,7 @@ public class KeyAgreement { ...@@ -418,7 +418,7 @@ public class KeyAgreement {
* *
* <p> If this key agreement requires any random bytes, it will get * <p> If this key agreement requires any random bytes, it will get
* them using the * them using the
* {@link SecureRandom <code>SecureRandom</code>} * {@link java.security.SecureRandom}
* implementation of the highest-priority * implementation of the highest-priority
* installed provider as the source of randomness. * installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
...@@ -476,7 +476,7 @@ public class KeyAgreement { ...@@ -476,7 +476,7 @@ public class KeyAgreement {
* *
* <p> If this key agreement requires any random bytes, it will get * <p> If this key agreement requires any random bytes, it will get
* them using the * them using the
* {@link SecureRandom <code>SecureRandom</code>} * {@link java.security.SecureRandom}
* implementation of the highest-priority * implementation of the highest-priority
* installed provider as the source of randomness. * installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
......
/* /*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -398,7 +398,7 @@ public class KeyGenerator { ...@@ -398,7 +398,7 @@ public class KeyGenerator {
* *
* <p> If this key generator requires any random bytes, it will get them * <p> If this key generator requires any random bytes, it will get them
* using the * using the
* {@link SecureRandom <code>SecureRandom</code>} * {@link java.security.SecureRandom}
* implementation of the highest-priority installed * implementation of the highest-priority installed
* provider as the source of randomness. * provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
...@@ -463,7 +463,7 @@ public class KeyGenerator { ...@@ -463,7 +463,7 @@ public class KeyGenerator {
* *
* <p> If this key generator requires any random bytes, it will get them * <p> If this key generator requires any random bytes, it will get them
* using the * using the
* {@link SecureRandom <code>SecureRandom</code>} * {@link java.security.SecureRandom}
* implementation of the highest-priority installed * implementation of the highest-priority installed
* provider as the source of randomness. * provider as the source of randomness.
* (If none of the installed providers supply an implementation of * (If none of the installed providers supply an implementation of
......
/* /*
* Copyright (c) 1997, 2007, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -38,6 +38,9 @@ package javax.crypto; ...@@ -38,6 +38,9 @@ package javax.crypto;
public class NullCipher extends Cipher { public class NullCipher extends Cipher {
/**
* Creates a NullCipher object.
*/
public NullCipher() { public NullCipher() {
super(new NullCipherSpi(), null); super(new NullCipherSpi(), null);
} }
......
/* /*
* Copyright (c) 1998, 2011, 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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -325,6 +325,9 @@ public final class Subject implements java.io.Serializable { ...@@ -325,6 +325,9 @@ public final class Subject implements java.io.Serializable {
* <code>action</code> will run as. This parameter * <code>action</code> will run as. This parameter
* may be <code>null</code>. <p> * may be <code>null</code>. <p>
* *
* @param <T> the type of the value returned by the PrivilegedAction's
* {@code run} method.
*
* @param action the code to be run as the specified * @param action the code to be run as the specified
* <code>Subject</code>. <p> * <code>Subject</code>. <p>
* *
...@@ -378,6 +381,9 @@ public final class Subject implements java.io.Serializable { ...@@ -378,6 +381,9 @@ public final class Subject implements java.io.Serializable {
* <code>action</code> will run as. This parameter * <code>action</code> will run as. This parameter
* may be <code>null</code>. <p> * may be <code>null</code>. <p>
* *
* @param <T> the type of the value returned by the
* PrivilegedExceptionAction's {@code run} method.
*
* @param action the code to be run as the specified * @param action the code to be run as the specified
* <code>Subject</code>. <p> * <code>Subject</code>. <p>
* *
...@@ -434,6 +440,9 @@ public final class Subject implements java.io.Serializable { ...@@ -434,6 +440,9 @@ public final class Subject implements java.io.Serializable {
* <code>action</code> will run as. This parameter * <code>action</code> will run as. This parameter
* may be <code>null</code>. <p> * may be <code>null</code>. <p>
* *
* @param <T> the type of the value returned by the PrivilegedAction's
* {@code run} method.
*
* @param action the code to be run as the specified * @param action the code to be run as the specified
* <code>Subject</code>. <p> * <code>Subject</code>. <p>
* *
...@@ -492,6 +501,9 @@ public final class Subject implements java.io.Serializable { ...@@ -492,6 +501,9 @@ public final class Subject implements java.io.Serializable {
* <code>action</code> will run as. This parameter * <code>action</code> will run as. This parameter
* may be <code>null</code>. <p> * may be <code>null</code>. <p>
* *
* @param <T> the type of the value returned by the
* PrivilegedExceptionAction's {@code run} method.
*
* @param action the code to be run as the specified * @param action the code to be run as the specified
* <code>Subject</code>. <p> * <code>Subject</code>. <p>
* *
...@@ -590,6 +602,8 @@ public final class Subject implements java.io.Serializable { ...@@ -590,6 +602,8 @@ public final class Subject implements java.io.Serializable {
* *
* <p> * <p>
* *
* @param <T> the type of the class modeled by {@code c}
*
* @param c the returned <code>Set</code> of Principals will all be * @param c the returned <code>Set</code> of Principals will all be
* instances of this class. * instances of this class.
* *
...@@ -684,6 +698,8 @@ public final class Subject implements java.io.Serializable { ...@@ -684,6 +698,8 @@ public final class Subject implements java.io.Serializable {
* *
* <p> * <p>
* *
* @param <T> the type of the class modeled by {@code c}
*
* @param c the returned <code>Set</code> of public credentials will all be * @param c the returned <code>Set</code> of public credentials will all be
* instances of this class. * instances of this class.
* *
...@@ -721,6 +737,8 @@ public final class Subject implements java.io.Serializable { ...@@ -721,6 +737,8 @@ public final class Subject implements java.io.Serializable {
* *
* <p> * <p>
* *
* @param <T> the type of the class modeled by {@code c}
*
* @param c the returned <code>Set</code> of private credentials will all be * @param c the returned <code>Set</code> of private credentials will all be
* instances of this class. * instances of this class.
* *
......
/* /*
* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -159,9 +159,9 @@ public abstract class X509Certificate extends Certificate { ...@@ -159,9 +159,9 @@ public abstract class X509Certificate extends Certificate {
* certificate is expected to be in the input stream. * certificate is expected to be in the input stream.
* Also, all X509Certificate * Also, all X509Certificate
* subclasses must provide a constructor of the form: * subclasses must provide a constructor of the form:
* <code><pre> * <pre>{@code
* public &lt;subClass&gt;(InputStream inStream) ... * public <subClass>(InputStream inStream) ...
* </pre></code> * }</pre>
* *
* @param inStream an input stream with the data to be read to * @param inStream an input stream with the data to be read to
* initialize the certificate. * initialize the certificate.
...@@ -184,9 +184,9 @@ public abstract class X509Certificate extends Certificate { ...@@ -184,9 +184,9 @@ public abstract class X509Certificate extends Certificate {
* *
* <p>Note: All X509Certificate * <p>Note: All X509Certificate
* subclasses must provide a constructor of the form: * subclasses must provide a constructor of the form:
* <code><pre> * <pre>{@code
* public &lt;subClass&gt;(InputStream inStream) ... * public <subClass>(InputStream inStream) ...
* </pre></code> * }</pre>
* *
* @param certData a byte array containing the DER-encoded * @param certData a byte array containing the DER-encoded
* certificate. * certificate.
...@@ -255,10 +255,12 @@ public abstract class X509Certificate extends Certificate { ...@@ -255,10 +255,12 @@ public abstract class X509Certificate extends Certificate {
* is valid. It is defined in * is valid. It is defined in
* ASN.1 as: * ASN.1 as:
* <pre> * <pre>
* validity Validity<p> * validity Validity
*
* Validity ::= SEQUENCE { * Validity ::= SEQUENCE {
* notBefore CertificateValidityDate, * notBefore CertificateValidityDate,
* notAfter CertificateValidityDate }<p> * notAfter CertificateValidityDate }
*
* CertificateValidityDate ::= CHOICE { * CertificateValidityDate ::= CHOICE {
* utcTime UTCTime, * utcTime UTCTime,
* generalTime GeneralizedTime } * generalTime GeneralizedTime }
...@@ -291,7 +293,8 @@ public abstract class X509Certificate extends Certificate { ...@@ -291,7 +293,8 @@ public abstract class X509Certificate extends Certificate {
* Gets the <code>version</code> (version number) value from the * Gets the <code>version</code> (version number) value from the
* certificate. The ASN.1 definition for this is: * certificate. The ASN.1 definition for this is:
* <pre> * <pre>
* version [0] EXPLICIT Version DEFAULT v1<p> * version [0] EXPLICIT Version DEFAULT v1
*
* Version ::= INTEGER { v1(0), v2(1), v3(2) } * Version ::= INTEGER { v1(0), v2(1), v3(2) }
* </pre> * </pre>
* *
...@@ -307,7 +310,7 @@ public abstract class X509Certificate extends Certificate { ...@@ -307,7 +310,7 @@ public abstract class X509Certificate extends Certificate {
* serial number identify a unique certificate). * serial number identify a unique certificate).
* The ASN.1 definition for this is: * The ASN.1 definition for this is:
* <pre> * <pre>
* serialNumber CertificateSerialNumber<p> * serialNumber CertificateSerialNumber
* *
* CertificateSerialNumber ::= INTEGER * CertificateSerialNumber ::= INTEGER
* </pre> * </pre>
...@@ -325,7 +328,7 @@ public abstract class X509Certificate extends Certificate { ...@@ -325,7 +328,7 @@ public abstract class X509Certificate extends Certificate {
* X.500 distinguished name (DN). * X.500 distinguished name (DN).
* The ASN.1 definition for this is: * The ASN.1 definition for this is:
* <pre> * <pre>
* issuer Name<p> * issuer Name
* *
* Name ::= CHOICE { RDNSequence } * Name ::= CHOICE { RDNSequence }
* RDNSequence ::= SEQUENCE OF RelativeDistinguishedName * RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
...@@ -371,11 +374,12 @@ public abstract class X509Certificate extends Certificate { ...@@ -371,11 +374,12 @@ public abstract class X509Certificate extends Certificate {
* the certificate. * the certificate.
* The relevant ASN.1 definitions are: * The relevant ASN.1 definitions are:
* <pre> * <pre>
* validity Validity<p> * validity Validity
* *
* Validity ::= SEQUENCE { * Validity ::= SEQUENCE {
* notBefore CertificateValidityDate, * notBefore CertificateValidityDate,
* notAfter CertificateValidityDate }<p> * notAfter CertificateValidityDate }
*
* CertificateValidityDate ::= CHOICE { * CertificateValidityDate ::= CHOICE {
* utcTime UTCTime, * utcTime UTCTime,
* generalTime GeneralizedTime } * generalTime GeneralizedTime }
...@@ -401,7 +405,8 @@ public abstract class X509Certificate extends Certificate { ...@@ -401,7 +405,8 @@ public abstract class X509Certificate extends Certificate {
* signature algorithm. An example is the string "SHA-1/DSA". * signature algorithm. An example is the string "SHA-1/DSA".
* The ASN.1 definition for this is: * The ASN.1 definition for this is:
* <pre> * <pre>
* signatureAlgorithm AlgorithmIdentifier<p> * signatureAlgorithm AlgorithmIdentifier
*
* AlgorithmIdentifier ::= SEQUENCE { * AlgorithmIdentifier ::= SEQUENCE {
* algorithm OBJECT IDENTIFIER, * algorithm OBJECT IDENTIFIER,
* parameters ANY DEFINED BY algorithm OPTIONAL } * parameters ANY DEFINED BY algorithm OPTIONAL }
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册