This method traverses the list of registered security Providers,
* starting with the most preferred Provider.
- * A new Signature object encapsulating the
- * SignatureSpi implementation from the first
- * Provider that supports the specified algorithm is returned.
+ * A new {@code Signature} object encapsulating the
+ * {@code SignatureSpi} implementation from the first
+ * provider that supports the specified algorithm is returned.
*
* Note that the list of registered providers may be retrieved via
* the {@link Security#getProviders() Security.getProviders()} method.
@@ -349,11 +349,11 @@ public abstract class Signature extends SignatureSpi {
}
/**
- * Returns a Signature object that implements the specified signature
- * algorithm.
+ * Returns a {@code Signature} object that implements the specified
+ * signature algorithm.
*
- *
A new Signature object encapsulating the
- * SignatureSpi implementation from the specified provider
+ *
A new {@code Signature} object encapsulating the
+ * {@code SignatureSpi} implementation from the specified provider
* is returned. The specified provider must be registered
* in the security provider list.
*
@@ -405,13 +405,13 @@ public abstract class Signature extends SignatureSpi {
}
/**
- * Returns a Signature object that implements the specified
+ * Returns a {@code Signature} object that implements the specified
* signature algorithm.
*
- *
A new Signature object encapsulating the
- * SignatureSpi implementation from the specified Provider
- * object is returned. Note that the specified Provider object
- * does not have to be registered in the provider list.
+ *
A new {@code Signature} object encapsulating the
+ * {@code SignatureSpi} implementation from the specified provider
+ * is returned. Note that the specified provider does not
+ * have to be registered in the provider list.
*
* @param algorithm the name of the algorithm requested.
* See the Signature section in the A call to this method resets this signature object to the state
- * it was in when previously initialized for signing via a
+ * A call to this method resets this {@code Signature} object to the
+ * state it was in when previously initialized for signing via a
* call to {@code initSign(PrivateKey)}. That is, the object is
* reset and available to generate another signature from the same
* signer, if desired, via new calls to {@code update} and
@@ -702,7 +704,7 @@ public abstract class Signature extends SignatureSpi {
*
* @return the signature bytes of the signing operation's result.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly or if this signature algorithm is unable to
* process the input data provided.
*/
@@ -721,8 +723,8 @@ public abstract class Signature extends SignatureSpi {
* The format of the signature depends on the underlying
* signature scheme.
*
- *
This signature object is reset to its initial state (the state it
- * was in after a call to one of the {@code initSign} methods) and
+ *
This {@code Signature} object is reset to its initial state (the
+ * state it was in after a call to one of the {@code initSign} methods) and
* can be reused to generate further signatures with the same private key.
*
* @param outbuf buffer for the signature result.
@@ -735,7 +737,7 @@ public abstract class Signature extends SignatureSpi {
*
* @return the number of bytes placed into {@code outbuf}.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly, if this signature algorithm is unable to
* process the input data provided, or if {@code len} is less
* than the actual signature length.
@@ -768,17 +770,17 @@ public abstract class Signature extends SignatureSpi {
/**
* Verifies the passed-in signature.
*
- *
A call to this method resets this signature object to the state
- * it was in when previously initialized for verification via a
+ *
A call to this method resets this {@code Signature} object to the
+ * state it was in when previously initialized for verification via a
* call to {@code initVerify(PublicKey)}. That is, the object is
* reset and available to verify another signature from the identity
* whose public key was specified in the call to {@code initVerify}.
*
* @param signature the signature bytes to be verified.
*
- * @return true if the signature was verified, false if not.
+ * @return {@code true} if the signature was verified, {@code false} if not.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly, the passed-in signature is improperly
* encoded or of the wrong type, if this signature algorithm is unable to
* process the input data provided, etc.
@@ -795,8 +797,8 @@ public abstract class Signature extends SignatureSpi {
* Verifies the passed-in signature in the specified array
* of bytes, starting at the specified offset.
*
- *
A call to this method resets this signature object to the state
- * it was in when previously initialized for verification via a
+ *
A call to this method resets this {@code Signature} object to the
+ * state it was in when previously initialized for verification via a
* call to {@code initVerify(PublicKey)}. That is, the object is
* reset and available to verify another signature from the identity
* whose public key was specified in the call to {@code initVerify}.
@@ -806,9 +808,9 @@ public abstract class Signature extends SignatureSpi {
* @param offset the offset to start from in the array of bytes.
* @param length the number of bytes to use, starting at offset.
*
- * @return true if the signature was verified, false if not.
+ * @return {@code true} if the signature was verified, {@code false} if not.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly, the passed-in signature is improperly
* encoded or of the wrong type, if this signature algorithm is unable to
* process the input data provided, etc.
@@ -845,7 +847,7 @@ public abstract class Signature extends SignatureSpi {
*
* @param b the byte to use for the update.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly.
*/
public final void update(byte b) throws SignatureException {
@@ -863,7 +865,7 @@ public abstract class Signature extends SignatureSpi {
*
* @param data the byte array to use for the update.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly.
*/
public final void update(byte[] data) throws SignatureException {
@@ -878,7 +880,7 @@ public abstract class Signature extends SignatureSpi {
* @param off the offset to start from in the array of bytes.
* @param len the number of bytes to use, starting at offset.
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly.
* @throws IllegalArgumentException if {@code data} is {@code null},
* or {@code off} or {@code len} is less than 0, or the sum of
@@ -914,7 +916,7 @@ public abstract class Signature extends SignatureSpi {
*
* @param data the ByteBuffer
*
- * @throws SignatureException if this signature object is not
+ * @throws SignatureException if this {@code Signature} object is not
* initialized properly.
* @since 1.5
*/
@@ -930,20 +932,20 @@ public abstract class Signature extends SignatureSpi {
}
/**
- * Returns the name of the algorithm for this signature object.
+ * Returns the name of the algorithm for this {@code Signature} object.
*
- * @return the name of the algorithm for this signature object.
+ * @return the name of the algorithm for this {@code Signature} object.
*/
public final String getAlgorithm() {
return this.algorithm;
}
/**
- * Returns a string representation of this signature object,
+ * Returns a string representation of this {@code Signature} object,
* providing information that includes the state of the object
* and the name of the algorithm used.
*
- * @return a string representation of this signature object.
+ * @return a string representation of this {@code Signature} object.
*/
public String toString() {
String initState = switch (state) {
@@ -970,7 +972,7 @@ public abstract class Signature extends SignatureSpi {
* @param value the parameter value
*
* @throws InvalidParameterException if {@code param} is an
- * invalid parameter for this signature object,
+ * invalid parameter for this {@code Signature} object,
* the parameter is already set
* and cannot be set again, a security exception occurs, and so on.
*
@@ -987,12 +989,13 @@ public abstract class Signature extends SignatureSpi {
}
/**
- * Initializes this signature object with the specified parameter values.
+ * Initializes this {@code Signature} object with the specified parameter
+ * values.
*
* @param params the parameter values
*
* @throws InvalidAlgorithmParameterException if the given parameter values
- * are inappropriate for this signature object
+ * are inappropriate for this {@code Signature} object
*
* @see #getParameters
*/
@@ -1002,20 +1005,21 @@ public abstract class Signature extends SignatureSpi {
}
/**
- * Returns the parameters used with this signature object.
+ * Returns the parameters used with this {@code Signature} object.
*
*
The returned parameters may be the same that were used to initialize
- * this signature object, or may contain additional default or random
- * parameter values used by the underlying signature scheme. If the required
- * parameters were not supplied and can be generated by the signature
- * object, the generated parameters are returned; otherwise {@code null} is
- * returned.
+ * this {@code Signature} object, or may contain additional default or
+ * random parameter values used by the underlying signature scheme.
+ * If the required parameters were not supplied and can be generated by
+ * the {@code Signature} object, the generated parameters are returned;
+ * otherwise {@code null} is returned.
*
*
However, if the signature scheme does not support returning
* the parameters as {@code AlgorithmParameters}, {@code null} is always
* returned.
*
- * @return the parameters used with this signature object, or {@code null}
+ * @return the parameters used with this {@code Signature} object,
+ * or {@code null}
* @throws UnsupportedOperationException if the provider does not support
* this method
*
@@ -1072,15 +1076,16 @@ public abstract class Signature extends SignatureSpi {
}
/*
- * The following class allows providers to extend from SignatureSpi
- * rather than from Signature. It represents a Signature with an
- * encapsulated, provider-supplied SPI object (of type SignatureSpi).
- * If the provider implementation is an instance of SignatureSpi, the
- * getInstance() methods above return an instance of this class, with
+ * The following class allows providers to extend from {@code SignatureSpi}
+ * rather than from {@code Signature}. It represents a {@code Signature}
+ * with an encapsulated, provider-supplied SPI object
+ * (of type {@code SignatureSpi}).
+ * If the provider implementation is an instance of {@code SignatureSpi},
+ * the getInstance() methods above return an instance of this class, with
* the SPI object encapsulated.
*
- * Note: All SPI methods from the original Signature class have been
- * moved up the hierarchy into a new class (SignatureSpi), which has
+ * Note: All SPI methods from the original {@code Signature} class have been
+ * moved up the hierarchy into a new class (SignatureSpi}, which has
* been interposed in the hierarchy between the API (Signature)
* and its original parent (Object).
*/
diff --git a/src/java.base/share/classes/java/security/SignatureException.java b/src/java.base/share/classes/java/security/SignatureException.java
index 9a0b29e8434..48015abb060 100644
--- a/src/java.base/share/classes/java/security/SignatureException.java
+++ b/src/java.base/share/classes/java/security/SignatureException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2022, 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
@@ -38,8 +38,8 @@ public class SignatureException extends GeneralSecurityException {
private static final long serialVersionUID = 7509989324975124438L;
/**
- * Constructs a SignatureException with no detail message. A
- * detail message is a String that describes this particular
+ * Constructs a {@code SignatureException} with no detail message. A
+ * detail message is a {@code String} that describes this particular
* exception.
*/
public SignatureException() {
@@ -47,8 +47,8 @@ public class SignatureException extends GeneralSecurityException {
}
/**
- * Constructs a SignatureException with the specified detail
- * message. A detail message is a String that describes this
+ * Constructs a {@code SignatureException} with the specified detail
+ * message. A detail message is a {@code String} that describes this
* particular exception.
*
* @param msg the detail message.
diff --git a/src/java.base/share/classes/java/security/SignatureSpi.java b/src/java.base/share/classes/java/security/SignatureSpi.java
index 9b1e3374a59..47479e7fcfd 100644
--- a/src/java.base/share/classes/java/security/SignatureSpi.java
+++ b/src/java.base/share/classes/java/security/SignatureSpi.java
@@ -60,7 +60,7 @@ public abstract class SignatureSpi {
protected SecureRandom appRandom = null;
/**
- * Initializes this signature object with the specified
+ * Initializes this {@code Signature} object with the specified
* public key for verification operations.
*
* @param publicKey the public key of the identity whose signature is
@@ -73,12 +73,12 @@ public abstract class SignatureSpi {
throws InvalidKeyException;
/**
- * Initializes this signature object with the specified
+ * Initializes this {@code Signature} object with the specified
* public key for verification operations.
*
* @param publicKey the public key of the identity whose signature is
* going to be verified.
- * @param params the parameters for verifying this signature object
+ * @param params the parameters for verifying this {@code Signature} object
*
* @throws InvalidKeyException if the key is improperly
* encoded, does not work with the given parameters, and so on.
@@ -100,7 +100,7 @@ public abstract class SignatureSpi {
}
/**
- * Initializes this signature object with the specified
+ * Initializes this {@code Signature} object with the specified
* private key for signing operations.
*
* @param privateKey the private key of the identity whose signature
@@ -113,7 +113,7 @@ public abstract class SignatureSpi {
throws InvalidKeyException;
/**
- * Initializes this signature object with the specified
+ * Initializes this {@code Signature} object with the specified
* private key and source of randomness for signing operations.
*
*
This concrete method has been added to this previously-defined
@@ -134,7 +134,7 @@ public abstract class SignatureSpi {
}
/**
- * Initializes this signature object with the specified
+ * Initializes this {@code Signature} object with the specified
* private key and source of randomness for signing operations.
*
*
This concrete method has been added to this previously-defined
@@ -269,7 +269,7 @@ public abstract class SignatureSpi {
* Both this default implementation and the SUN provider do not
* return partial digests. If the value of this parameter is less
* than the actual signature length, this method will throw a
- * SignatureException.
+ * {@code SignatureException}.
* This parameter is ignored if its value is greater than or equal to
* the actual signature length.
*
@@ -303,7 +303,7 @@ public abstract class SignatureSpi {
*
* @param sigBytes the signature bytes to be verified.
*
- * @return true if the signature was verified, false if not.
+ * @return {@code true} if the signature was verified, {@code false} if not.
*
* @throws SignatureException if the engine is not
* initialized properly, the passed-in signature is improperly
@@ -324,7 +324,7 @@ public abstract class SignatureSpi {
* @param offset the offset to start from in the array of bytes.
* @param length the number of bytes to use, starting at offset.
*
- * @return true if the signature was verified, false if not.
+ * @return {@code true} if the signature was verified, {@code false} if not.
*
* @throws SignatureException if the engine is not
* initialized properly, the passed-in signature is improperly
@@ -355,7 +355,7 @@ public abstract class SignatureSpi {
* @param value the parameter value.
*
* @throws InvalidParameterException if {@code param} is an
- * invalid parameter for this signature object,
+ * invalid parameter for this {@code Signature} object,
* the parameter is already set
* and cannot be set again, a security exception occurs, and so on.
*
@@ -368,7 +368,8 @@ public abstract class SignatureSpi {
throws InvalidParameterException;
/**
- * Initializes this signature object with the specified parameter values.
+ * Initializes this {@code Signature} object with the specified parameter
+ * values.
*
* @param params the parameters
*
@@ -377,7 +378,7 @@ public abstract class SignatureSpi {
*
* @throws InvalidAlgorithmParameterException if this method is
* overridden by a provider and the given parameters
- * are inappropriate for this signature object
+ * are inappropriate for this {@code Signature} object
*/
protected void engineSetParameter(AlgorithmParameterSpec params)
throws InvalidAlgorithmParameterException {
@@ -385,20 +386,21 @@ public abstract class SignatureSpi {
}
/**
- * Returns the parameters used with this signature object.
+ * Returns the parameters used with this {@code Signature} object.
*
*
The returned parameters may be the same that were used to initialize
- * this signature object, or may contain additional default or random
- * parameter values used by the underlying signature scheme. If the required
- * parameters were not supplied and can be generated by the signature
- * object, the generated parameters are returned; otherwise {@code null} is
- * returned.
+ * this {@code Signature} object, or may contain additional default or
+ * random parameter values used by the underlying signature scheme.
+ * If the required parameters were not supplied and can be generated by
+ * the {@code Signature} object, the generated parameters are returned;
+ * otherwise {@code null} is returned.
*
*
However, if the signature scheme does not support returning
* the parameters as {@code AlgorithmParameters}, {@code null} is always
* returned.
*
- * @return the parameters used with this signature object, or {@code null}
+ * @return the parameters used with this {@code Signature} object, or
+ * {@code null}
*
* @throws UnsupportedOperationException if this method is not overridden
* by a provider
@@ -421,8 +423,8 @@ public abstract class SignatureSpi {
*
* @param param the string name of the parameter.
*
- * @return the object that represents the parameter value, or {@code null} if
- * there is none.
+ * @return the object that represents the parameter value, or {@code null}
+ * if there is none.
*
* @throws InvalidParameterException if {@code param} is an
* invalid parameter for this engine, or another exception occurs while
diff --git a/src/java.base/share/classes/java/security/SignedObject.java b/src/java.base/share/classes/java/security/SignedObject.java
index 0fe6c38370f..e2f9c764ec2 100644
--- a/src/java.base/share/classes/java/security/SignedObject.java
+++ b/src/java.base/share/classes/java/security/SignedObject.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, 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
@@ -28,11 +28,11 @@ package java.security;
import java.io.*;
/**
- *
SignedObject is a class for the purpose of creating authentic
+ *
{@code SignedObject} is a class for the purpose of creating authentic
* runtime objects whose integrity cannot be compromised without being
* detected.
*
- *
More specifically, a SignedObject contains another Serializable
+ *
More specifically, a {@code SignedObject} contains another Serializable
* object, the (to-be-)signed object and its signature.
*
*
The signed object is a "deep copy" (in serialized form) of an
@@ -67,7 +67,7 @@ import java.io.*;
* re-initialized inside the constructor and the {@code verify}
* method. Secondly, for verification to succeed, the specified
* public key must be the public key corresponding to the private key
- * used to generate the SignedObject.
+ * used to generate the {@code SignedObject}.
*
*
More importantly, for flexibility reasons, the
* constructor and {@code verify} method allow for
@@ -95,7 +95,7 @@ import java.io.*;
* specified, the default provider is used. Each installation can
* be configured to use a particular provider as default.
*
- *
Potential applications of SignedObject include:
+ *
Potential applications of {@code SignedObject} include:
*
* - It can be used
* internally to any Java runtime as an unforgeable authorization
@@ -138,7 +138,7 @@ public final class SignedObject implements Serializable {
private String thealgorithm;
/**
- * Constructs a SignedObject from any Serializable object.
+ * Constructs a {@code SignedObject} from any Serializable object.
* The given object is signed with the given signing key, using the
* designated signature engine.
*
@@ -211,7 +211,7 @@ public final class SignedObject implements Serializable {
}
/**
- * Verifies that the signature in this SignedObject is the valid
+ * Verifies that the signature in this {@code SignedObject} is the valid
* signature for the object stored inside, with the given
* verification key, using the designated verification engine.
*
@@ -254,8 +254,8 @@ public final class SignedObject implements Serializable {
}
/**
- * readObject is called to restore the state of the SignedObject from
- * a stream.
+ * readObject is called to restore the state of the {@code SignedObject}
+ * from a stream.
*
* @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
diff --git a/src/java.base/share/classes/java/security/Signer.java b/src/java.base/share/classes/java/security/Signer.java
index b864004aa53..bb3e55040ef 100644
--- a/src/java.base/share/classes/java/security/Signer.java
+++ b/src/java.base/share/classes/java/security/Signer.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2022, 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
@@ -60,7 +60,7 @@ public abstract class Signer extends Identity {
private PrivateKey privateKey;
/**
- * Creates a signer. This constructor should only be used for
+ * Creates a {@code Signer}. This constructor should only be used for
* serialization.
*/
protected Signer() {
@@ -69,7 +69,7 @@ public abstract class Signer extends Identity {
/**
- * Creates a signer with the specified identity name.
+ * Creates a {@code Signer} with the specified identity name.
*
* @param name the identity name.
*/
@@ -78,7 +78,7 @@ public abstract class Signer extends Identity {
}
/**
- * Creates a signer with the specified identity name and scope.
+ * Creates a {@code Signer} with the specified identity name and scope.
*
* @param name the identity name.
*
@@ -99,7 +99,7 @@ public abstract class Signer extends Identity {
* method is called with {@code "getSignerPrivateKey"}
* as its argument to see if it's ok to return the private key.
*
- * @return this signer's private key, or null if the private key has
+ * @return this signer's private key, or {@code null} if the private key has
* not yet been set.
*
* @throws SecurityException if a security manager exists and its
@@ -114,7 +114,7 @@ public abstract class Signer extends Identity {
}
/**
- * Sets the key pair (public key and private key) for this signer.
+ * Sets the key pair (public key and private key) for this {@code Signer}.
*
*
First, if there is a security manager, its {@code checkSecurityAccess}
* method is called with {@code "setSignerKeyPair"}
@@ -168,9 +168,9 @@ public abstract class Signer extends Identity {
}
/**
- * Returns a string of information about the signer.
+ * Returns a string of information about the {@code Signer}.
*
- * @return a string of information about the signer.
+ * @return a string of information about the {@code Signer}.
*/
public String toString() {
return "[Signer]" + super.toString();
diff --git a/src/java.base/share/classes/java/security/Timestamp.java b/src/java.base/share/classes/java/security/Timestamp.java
index 5f6ccf6b460..10a93a9b180 100644
--- a/src/java.base/share/classes/java/security/Timestamp.java
+++ b/src/java.base/share/classes/java/security/Timestamp.java
@@ -68,11 +68,14 @@ public final class Timestamp implements Serializable {
private transient int myhash = -1;
/**
- * Constructs a Timestamp.
+ * Constructs a {@code Timestamp}.
*
- * @param timestamp is the timestamp's date and time. It must not be null.
- * @param signerCertPath is the TSA's certificate path. It must not be null.
- * @throws NullPointerException if timestamp or signerCertPath is null.
+ * @param timestamp is the timestamp's date and time. It must not be
+ * {@code null}.
+ * @param signerCertPath is the TSA's certificate path. It must not be
+ * {@code null}.
+ * @throws NullPointerException if timestamp or signerCertPath is
+ * {@code null}.
*/
public Timestamp(Date timestamp, CertPath signerCertPath) {
if (timestamp == null || signerCertPath == null) {
@@ -83,7 +86,7 @@ public final class Timestamp implements Serializable {
}
/**
- * Returns the date and time when the timestamp was generated.
+ * Returns the date and time when the {@code Timestamp} was generated.
*
* @return The timestamp's date and time.
*/
@@ -101,11 +104,11 @@ public final class Timestamp implements Serializable {
}
/**
- * Returns the hash code value for this timestamp.
- * The hash code is generated using the date and time of the timestamp
- * and the TSA's certificate path.
+ * Returns the hash code value for this {@code Timestamp}.
+ * The hash code is generated using the date and time of the
+ * {@code Timestamp} and the TSA's certificate path.
*
- * @return a hash code value for this timestamp.
+ * @return a hash code value for this {@code Timestamp}.
*/
public int hashCode() {
if (myhash == -1) {
@@ -116,12 +119,13 @@ public final class Timestamp implements Serializable {
/**
* Tests for equality between the specified object and this
- * timestamp. Two timestamps are considered equal if the date and time of
- * their timestamp's and their signer's certificate paths are equal.
+ * {@code Timestamp}. Two timestamps are considered equal if the date and
+ * time of their timestamp's and their signer's certificate paths are equal.
*
- * @param obj the object to test for equality with this timestamp.
+ * @param obj the object to test for equality with this {@code Timestamp}.
*
- * @return true if the timestamp are considered equal, false otherwise.
+ * @return {@code true} if the timestamps are considered equal,
+ * {@code false} otherwise.
*/
public boolean equals(Object obj) {
if (this == obj) {
@@ -133,10 +137,10 @@ public final class Timestamp implements Serializable {
}
/**
- * Returns a string describing this timestamp.
+ * Returns a string describing this {@code Timestamp}.
*
- * @return A string comprising the date and time of the timestamp and
- * its signer's certificate.
+ * @return A string comprising the date and time of the {@code Timestamp}
+ * and its signer's certificate.
*/
public String toString() {
StringBuilder sb = new StringBuilder();
diff --git a/src/java.base/share/classes/java/security/URIParameter.java b/src/java.base/share/classes/java/security/URIParameter.java
index eba035c9966..43ee98ee937 100644
--- a/src/java.base/share/classes/java/security/URIParameter.java
+++ b/src/java.base/share/classes/java/security/URIParameter.java
@@ -39,12 +39,12 @@ public class URIParameter implements
private final java.net.URI uri;
/**
- * Constructs a URIParameter with the URI pointing to
+ * Constructs a {@code URIParameter} with the URI pointing to
* data intended for an SPI implementation.
*
* @param uri the URI pointing to the data.
*
- * @throws NullPointerException if the specified URI is null.
+ * @throws NullPointerException if the specified URI is {@code null}.
*/
public URIParameter(java.net.URI uri) {
if (uri == null) {
diff --git a/src/java.base/share/classes/java/security/UnrecoverableEntryException.java b/src/java.base/share/classes/java/security/UnrecoverableEntryException.java
index 19f4ddceb99..a3256953e99 100644
--- a/src/java.base/share/classes/java/security/UnrecoverableEntryException.java
+++ b/src/java.base/share/classes/java/security/UnrecoverableEntryException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2022, 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
@@ -38,15 +38,15 @@ public class UnrecoverableEntryException extends GeneralSecurityException {
private static final long serialVersionUID = -4527142945246286535L;
/**
- * Constructs an UnrecoverableEntryException with no detail message.
+ * Constructs an {@code UnrecoverableEntryException} with no detail message.
*/
public UnrecoverableEntryException() {
super();
}
/**
- * Constructs an UnrecoverableEntryException with the specified detail
- * message, which provides more information about why this exception
+ * Constructs an {@code UnrecoverableEntryException} with the specified
+ * detail message, which provides more information about why this exception
* has been thrown.
*
* @param msg the detail message.
diff --git a/src/java.base/share/classes/java/security/UnrecoverableKeyException.java b/src/java.base/share/classes/java/security/UnrecoverableKeyException.java
index da415218294..e3fa7219e2b 100644
--- a/src/java.base/share/classes/java/security/UnrecoverableKeyException.java
+++ b/src/java.base/share/classes/java/security/UnrecoverableKeyException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, 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
@@ -38,14 +38,14 @@ public class UnrecoverableKeyException extends UnrecoverableEntryException {
private static final long serialVersionUID = 7275063078190151277L;
/**
- * Constructs an UnrecoverableKeyException with no detail message.
+ * Constructs an {@code UnrecoverableKeyException} with no detail message.
*/
public UnrecoverableKeyException() {
super();
}
/**
- * Constructs an UnrecoverableKeyException with the specified detail
+ * Constructs an {@code UnrecoverableKeyException} with the specified detail
* message, which provides more information about why this exception
* has been thrown.
*
diff --git a/src/java.base/share/classes/java/security/UnresolvedPermission.java b/src/java.base/share/classes/java/security/UnresolvedPermission.java
index 486deab67ae..5029b97be40 100644
--- a/src/java.base/share/classes/java/security/UnresolvedPermission.java
+++ b/src/java.base/share/classes/java/security/UnresolvedPermission.java
@@ -37,7 +37,7 @@ import java.security.cert.*;
import java.util.List;
/**
- * The UnresolvedPermission class is used to hold Permissions that
+ * The {@code UnresolvedPermission} class is used to hold Permissions that
* were "unresolved" when the Policy was initialized.
* An unresolved permission is one whose actual Permission class
* does not yet exist at the time the Policy is initialized (see below).
@@ -60,33 +60,33 @@ import java.util.List;
*
Other permission classes may not yet exist during Policy
* initialization. For example, a referenced permission class may
* be in a JAR file that will later be loaded.
- * For each such class, an UnresolvedPermission is instantiated.
- * Thus, an UnresolvedPermission is essentially a "placeholder"
+ * For each such class, an {@code UnresolvedPermission} is instantiated.
+ * Thus, an {@code UnresolvedPermission} is essentially a "placeholder"
* containing information about the permission.
*
- *
Later, when code calls AccessController.checkPermission
+ *
Later, when code calls {@link AccessController#checkPermission}
* on a permission of a type that was previously unresolved,
* but whose class has since been loaded, previously-unresolved
* permissions of that type are "resolved". That is,
- * for each such UnresolvedPermission, a new object of
+ * for each such {@code UnresolvedPermission}, a new object of
* the appropriate class type is instantiated, based on the
- * information in the UnresolvedPermission.
+ * information in the {@code UnresolvedPermission}.
*
- *
To instantiate the new class, UnresolvedPermission assumes
+ *
To instantiate the new class, {@code UnresolvedPermission} assumes
* the class provides a zero, one, and/or two-argument constructor.
* The zero-argument constructor would be used to instantiate
* a permission without a name and without actions.
* A one-arg constructor is assumed to take a {@code String}
* name as input, and a two-arg constructor is assumed to take a
* {@code String} name and {@code String} actions
- * as input. UnresolvedPermission may invoke a
+ * as input. {@code UnresolvedPermission} may invoke a
* constructor with a {@code null} name and/or actions.
* If an appropriate permission constructor is not available,
- * the UnresolvedPermission is ignored and the relevant permission
+ * the {@code UnresolvedPermission} is ignored and the relevant permission
* will not be granted to executing code.
*
*
The newly created permission object replaces the
- * UnresolvedPermission, which is removed.
+ * {@code UnresolvedPermission}, which is removed.
*
*
Note that the {@code getName} method for an
* {@code UnresolvedPermission} returns the
@@ -139,7 +139,7 @@ implements java.io.Serializable
private transient java.security.cert.Certificate[] certs;
/**
- * Creates a new UnresolvedPermission containing the permission
+ * Creates a new {@code UnresolvedPermission} containing the permission
* information needed later to actually create a Permission of the
* specified class, when the permission is resolved.
*
@@ -302,21 +302,21 @@ implements java.io.Serializable
}
/**
- * This method always returns false for unresolved permissions.
- * That is, an UnresolvedPermission is never considered to
+ * This method always returns {@code false} for unresolved permissions.
+ * That is, an {@code UnresolvedPermission} is never considered to
* imply another permission.
*
* @param p the permission to check against.
*
- * @return false.
+ * @return {@code false}.
*/
public boolean implies(Permission p) {
return false;
}
/**
- * Checks two UnresolvedPermission objects for equality.
- * Checks that {@code obj} is an UnresolvedPermission, and has
+ * Checks two {@code UnresolvedPermission} objects for equality.
+ * Checks that {@code obj} is an {@code UnresolvedPermission}, and has
* the same type (class) name, permission name, actions, and
* certificates as this object.
*
@@ -326,8 +326,8 @@ implements java.io.Serializable
*
* @param obj the object we are testing for equality with this object.
*
- * @return true if obj is an UnresolvedPermission, and has the same
- * type (class) name, permission name, actions, and
+ * @return true if {@code obj} is an {@code UnresolvedPermission},
+ * and has the same type (class) name, permission name, actions, and
* certificates as this object.
*/
public boolean equals(Object obj) {
@@ -415,9 +415,9 @@ implements java.io.Serializable
/**
* Returns the canonical string representation of the actions,
* which currently is the empty string "", since there are no actions for
- * an UnresolvedPermission. That is, the actions for the
- * permission that will be created when this UnresolvedPermission
- * is resolved may be non-null, but an UnresolvedPermission
+ * an {@code UnresolvedPermission}. That is, the actions for the
+ * permission that will be created when this {@code UnresolvedPermission}
+ * is resolved may be non-null, but an {@code UnresolvedPermission}
* itself is never considered to have any actions.
*
* @return the empty string "".
@@ -473,7 +473,8 @@ implements java.io.Serializable
* for the underlying permission that has not been resolved.
*
* @return the signer certificates for the underlying permission that
- * has not been resolved, or null, if there are no signer certificates.
+ * has not been resolved, or {@code null}, if there are no signer
+ * certificates.
* Returns a new array each time this method is called.
*
* @since 1.5
@@ -483,11 +484,12 @@ implements java.io.Serializable
}
/**
- * Returns a string describing this UnresolvedPermission. The convention
- * is to specify the class name, the permission name, and the actions, in
- * the following format: '(unresolved "ClassName" "name" "actions")'.
+ * Returns a string describing this {@code UnresolvedPermission}.
+ * The convention is to specify the class name, the permission name,
+ * and the actions, in the following format:
+ * '(unresolved "ClassName" "name" "actions")'.
*
- * @return information about this UnresolvedPermission.
+ * @return information about this {@code UnresolvedPermission}.
*/
public String toString() {
return "(unresolved " + type + " " + name + " " + actions + ")";
@@ -495,10 +497,10 @@ implements java.io.Serializable
/**
* Returns a new PermissionCollection object for storing
- * UnresolvedPermission objects.
+ * {@code UnresolvedPermission} objects.
*
* @return a new PermissionCollection object suitable for
- * storing UnresolvedPermissions.
+ * storing {@code UnresolvedPermissions}.
*/
public PermissionCollection newPermissionCollection() {
diff --git a/src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java b/src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java
index 61d2e7ce1ef..a98be622bb1 100644
--- a/src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java
+++ b/src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, 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
@@ -34,7 +34,7 @@ import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
/**
- * A UnresolvedPermissionCollection stores a collection
+ * A {@code UnresolvedPermissionCollection} stores a collection
* of UnresolvedPermission permissions.
*
* @see java.security.Permission
@@ -60,7 +60,7 @@ implements java.io.Serializable
private transient ConcurrentHashMap> perms;
/**
- * Create an empty UnresolvedPermissionCollection object.
+ * Create an empty {@code UnresolvedPermissionCollection} object.
*
*/
public UnresolvedPermissionCollection() {
@@ -68,7 +68,7 @@ implements java.io.Serializable
}
/**
- * Adds a permission to this UnresolvedPermissionCollection.
+ * Adds a permission to this {@code UnresolvedPermissionCollection}.
* The key for the hash is the unresolved permission's type (class) name.
*
* @param permission the Permission object to add.
@@ -109,7 +109,7 @@ implements java.io.Serializable
}
/**
- * always returns false for unresolved permissions
+ * always returns {@code false} for unresolved permissions
*
*/
@Override
diff --git a/src/java.base/share/classes/javax/crypto/AEADBadTagException.java b/src/java.base/share/classes/javax/crypto/AEADBadTagException.java
index 615f64986bb..455e6c22431 100644
--- a/src/java.base/share/classes/javax/crypto/AEADBadTagException.java
+++ b/src/java.base/share/classes/javax/crypto/AEADBadTagException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2011, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2022, 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
@@ -38,14 +38,14 @@ public class AEADBadTagException extends BadPaddingException {
private static final long serialVersionUID = -488059093241685509L;
/**
- * Constructs a AEADBadTagException with no detail message.
+ * Constructs an {@code AEADBadTagException} with no detail message.
*/
public AEADBadTagException() {
super();
}
/**
- * Constructs a AEADBadTagException with the specified
+ * Constructs an {@code AEADBadTagException} with the specified
* detail message.
*
* @param msg the detail message.
diff --git a/src/java.base/share/classes/javax/crypto/BadPaddingException.java b/src/java.base/share/classes/javax/crypto/BadPaddingException.java
index bbd2498c35f..2d918dcaa17 100644
--- a/src/java.base/share/classes/javax/crypto/BadPaddingException.java
+++ b/src/java.base/share/classes/javax/crypto/BadPaddingException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, 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
@@ -41,8 +41,8 @@ public class BadPaddingException extends GeneralSecurityException {
private static final long serialVersionUID = -5315033893984728443L;
/**
- * Constructs a BadPaddingException with no detail
- * message. A detail message is a String that describes this
+ * Constructs a {@code BadPaddingException} with no detail
+ * message. A detail message is a {@code String} that describes this
* particular exception.
*/
public BadPaddingException() {
@@ -50,7 +50,7 @@ public class BadPaddingException extends GeneralSecurityException {
}
/**
- * Constructs a BadPaddingException with the specified
+ * Constructs a {@code BadPaddingException} with the specified
* detail message.
*
* @param msg the detail message.
diff --git a/src/java.base/share/classes/javax/crypto/Cipher.java b/src/java.base/share/classes/javax/crypto/Cipher.java
index 32a37ff01a1..5d2f37d6312 100644
--- a/src/java.base/share/classes/javax/crypto/Cipher.java
+++ b/src/java.base/share/classes/javax/crypto/Cipher.java
@@ -52,7 +52,7 @@ import sun.security.util.KnownOIDs;
* encryption and decryption. It forms the core of the Java Cryptographic
* Extension (JCE) framework.
*
- * In order to create a {code Cipher} object, the application calls the
+ *
In order to create a {@code Cipher} object, the application calls the
* cipher's {@code getInstance} method, and passes the name of the
* requested transformation to it. Optionally, the name of a provider
* may be specified.
@@ -141,8 +141,8 @@ import sun.security.util.KnownOIDs;
* information on the ChaCha20 and ChaCha20-Poly1305 algorithms.
*
* Every implementation of the Java platform is required to support
- * the following standard {@code Cipher} transformations with the keysizes
- * in parentheses:
+ * the following standard {@code Cipher} object transformations with
+ * the keysizes in parentheses:
*
* - {@code AES/CBC/NoPadding} (128)
* - {@code AES/CBC/PKCS5Padding} (128)
@@ -258,14 +258,14 @@ public class Cipher {
private final Object lock;
/**
- * Creates a {code Cipher} object.
+ * Creates a {@code Cipher} object.
*
* @param cipherSpi the delegate
* @param provider the provider
* @param transformation the transformation
* @throws NullPointerException if {@code provider} is {@code null}
* @throws IllegalArgumentException if the supplied arguments
- * are deemed invalid for constructing the {code Cipher} object
+ * are deemed invalid for constructing the {@code Cipher} object
*/
protected Cipher(CipherSpi cipherSpi,
Provider provider,
@@ -515,7 +515,8 @@ public class Cipher {
* Java Security Standard Algorithm Names Specification
* for information about standard transformation names.
*
- * @return a cipher that implements the requested transformation
+ * @return a {@code Cipher} object that implements the requested
+ * transformation
*
* @throws NoSuchAlgorithmException if {@code transformation}
* is {@code null}, empty, in an invalid format,
@@ -606,7 +607,8 @@ public class Cipher {
*
* @param provider the name of the provider
*
- * @return a cipher that implements the requested transformation
+ * @return a {@code Cipher} object that implements the requested
+ * transformation
*
* @throws IllegalArgumentException if the {@code provider}
* is {@code null} or empty
@@ -677,7 +679,8 @@ public class Cipher {
*
* @param provider the provider
*
- * @return a cipher that implements the requested transformation
+ * @return a {@code Cipher} object that implements the requested
+ * transformation
*
* @throws IllegalArgumentException if the {@code provider}
* is {@code null}
@@ -1014,8 +1017,8 @@ public class Cipher {
*
* @return the required output buffer size (in bytes)
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not yet been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object is in a
+ * wrong state (e.g., has not yet been initialized)
*/
public final int getOutputSize(int inputLen) {
@@ -1047,7 +1050,7 @@ public class Cipher {
}
/**
- * Returns the parameters used with this cipher.
+ * Returns the parameters used with this {@code Cipher} object.
*
*
The returned parameters may be the same that were used to initialize
* this cipher, or may contain additional default or random parameter
@@ -1063,10 +1066,12 @@ public class Cipher {
}
/**
- * Returns the exemption mechanism object used with this cipher.
+ * Returns the exemption mechanism object used with this {@code Cipher}
+ * object.
*
- * @return the exemption mechanism object used with this cipher, or
- * {@code null} if this cipher does not use any exemption mechanism.
+ * @return the exemption mechanism object used with this {@code Cipher}
+ * object, or {@code null} if this {@code Cipher} object does not use any
+ * exemption mechanism.
*/
public final ExemptionMechanism getExemptionMechanism() {
chooseFirstProvider();
@@ -1183,9 +1188,10 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key.
+ * Initializes this {@code Cipher} object with a key.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1214,12 +1220,12 @@ public class Cipher {
* SecureRandom, a system-provided source of randomness will be used.)
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of
- * the following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param key the key
@@ -1239,9 +1245,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key and a source of randomness.
+ * Initializes this {@code Cipher} object with a key and a
+ * source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1266,12 +1274,12 @@ public class Cipher {
* them from {@code random}.
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that
+ * {@code Cipher} object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -1314,10 +1322,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key and a set of algorithm
+ * Initializes this {@code Cipher} object with a key and a set of algorithm
* parameters.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1346,12 +1355,12 @@ public class Cipher {
* SecureRandom, a system-provided source of randomness will be used.)
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -1378,10 +1387,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key, a set of algorithm
+ * Initializes this {@code Cipher} object with a key, a set of algorithm
* parameters, and a source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1406,12 +1416,12 @@ public class Cipher {
* them from {@code random}.
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -1455,10 +1465,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key and a set of algorithm
+ * Initializes this {@code Cipher} object with a key and a set of algorithm
* parameters.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1487,12 +1498,12 @@ public class Cipher {
* SecureRandom, a system-provided source of randomness will be used.)
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following: {@code ENCRYPT_MODE},
+ * @param opmode the operation mode of this {@code Cipher} object
+ * this is one of the following: {@code ENCRYPT_MODE},
* {@code DECRYPT_MODE}, {@code WRAP_MODE}
* or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -1519,10 +1530,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with a key, a set of algorithm
+ * Initializes this {@code Cipher} object with a key, a set of algorithm
* parameters, and a source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1547,12 +1559,12 @@ public class Cipher {
* them from {@code random}.
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following: {@code ENCRYPT_MODE},
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following: {@code ENCRYPT_MODE},
* {@code DECRYPT_MODE}, {@code WRAP_MODE}
* or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -1596,8 +1608,10 @@ public class Cipher {
}
/**
- * Initializes this cipher with the public key from the given certificate.
- *
The cipher is initialized for one of the following four operations:
+ * Initializes this {@code Cipher} object with the public key from the given
+ * certificate.
+ *
The {@code Cipher} object is initialized for one of the following
+ * four operations:
* encryption, decryption, key wrapping or key unwrapping, depending
* on the value of {@code opmode}.
*
@@ -1637,12 +1651,12 @@ public class Cipher {
* SecureRandom, a system-provided source of randomness will be used.)
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param certificate the certificate
@@ -1665,11 +1679,11 @@ public class Cipher {
}
/**
- * Initializes this cipher with the public key from the given certificate
- * and a source of randomness.
+ * Initializes this {@code Cipher} object with the public key from the given
+ * certificate and a source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
- * encryption, decryption, key wrapping
+ *
The {@code Cipher} object is initialized for one of the following four
+ * operations: encryption, decryption, key wrapping
* or key unwrapping, depending on
* the value of {@code opmode}.
*
@@ -1704,12 +1718,12 @@ public class Cipher {
* them from {@code random}.
*
*
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ * previously-acquired state. In other words, initializing a {@code Cipher}
+ * object is equivalent to creating a new instance of that {@code Cipher}
+ * object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of the
- * following:
+ * @param opmode the operation mode of this {@code Cipher} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param certificate the certificate
@@ -1782,9 +1796,11 @@ public class Cipher {
}
/**
- * Ensures that cipher is in a valid state for update() and doFinal()
- * calls - should be initialized and in ENCRYPT_MODE or DECRYPT_MODE.
- * @throws IllegalStateException if this cipher is not in valid state
+ * Ensures that {@code Cipher} object is in a valid state for update() and
+ * doFinal() calls - should be initialized and in ENCRYPT_MODE or
+ * DECRYPT_MODE.
+ * @throws IllegalStateException if this {@code Cipher} object is not in
+ * valid state
*/
private void checkCipherState() {
if (!(this instanceof NullCipher)) {
@@ -1801,8 +1817,8 @@ public class Cipher {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code Cipher} object was initialized),
+ * processing another data part.
*
*
The bytes in the {@code input} buffer are processed, and the
* result is stored in a new buffer.
@@ -1816,8 +1832,8 @@ public class Cipher {
* cipher is a block cipher and the input data is too short to result in a
* new block
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object is in a
+ * wrong state (e.g., has not been initialized)
*/
public final byte[] update(byte[] input) {
checkCipherState();
@@ -1836,8 +1852,8 @@ public class Cipher {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code Cipher} object was initialized),
+ * processing another data part.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, are processed,
@@ -1851,12 +1867,12 @@ public class Cipher {
* starts
* @param inputLen the input length
*
- * @return the new buffer with the result, or null if this
+ * @return the new buffer with the result, or {@code null} if this
* cipher is a block cipher and the input data is too short to result in a
* new block.
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
*/
public final byte[] update(byte[] input, int inputOffset, int inputLen) {
checkCipherState();
@@ -1876,8 +1892,8 @@ public class Cipher {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code Cipher} object was initialized),
+ * processing another data part.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, are processed,
@@ -1905,8 +1921,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
*/
@@ -1931,8 +1947,8 @@ public class Cipher {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code Cipher} object was initialized),
+ * processing another data part.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, are processed,
@@ -1963,8 +1979,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
*/
@@ -1990,8 +2006,8 @@ public class Cipher {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code Cipher} object was initialized),
+ * processing another data part.
*
*
All {@code input.remaining()} bytes starting at
* {@code input.position()} are processed. The result is stored
@@ -2017,8 +2033,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalArgumentException if input and output are the
* same object
* @throws ReadOnlyBufferException if the output buffer is read-only
@@ -2047,7 +2063,7 @@ public class Cipher {
/**
* Finishes a multiple-part encryption or decryption operation, depending
- * on how this cipher was initialized.
+ * on how this {@code Cipher} object was initialized.
*
*
Input data that may have been buffered during a previous
* {@code update} operation is processed, with padding (if requested)
@@ -2057,29 +2073,30 @@ public class Cipher {
* case of decryption.
* The result is stored in a new buffer.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
* @return the new buffer with the result
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
* block size; or if this encryption algorithm is unable to
* process the input data provided.
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final byte[] doFinal()
@@ -2092,7 +2109,7 @@ public class Cipher {
/**
* Finishes a multiple-part encryption or decryption operation, depending
- * on how this cipher was initialized.
+ * on how this {@code Cipher} object was initialized.
*
*
Input data that may have been buffered during a previous
* {@code update} operation is processed, with padding (if requested)
@@ -2109,14 +2126,15 @@ public class Cipher {
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
* @param output the buffer for the result
* @param outputOffset the offset in {@code output} where the result
@@ -2124,8 +2142,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
@@ -2133,11 +2151,11 @@ public class Cipher {
* process the input data provided.
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the
+ * decrypted data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final int doFinal(byte[] output, int outputOffset)
@@ -2157,7 +2175,7 @@ public class Cipher {
/**
* Encrypts or decrypts data in a single-part operation, or finishes a
* multiple-part operation. The data is encrypted or decrypted,
- * depending on how this cipher was initialized.
+ * depending on how this {@code Cipher} object was initialized.
*
*
The bytes in the {@code input} buffer, and any input bytes that
* may have been buffered during a previous {@code update} operation,
@@ -2167,31 +2185,32 @@ public class Cipher {
* case of decryption.
* The result is stored in a new buffer.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
* @param input the input buffer
*
* @return the new buffer with the result
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
* block size; or if this encryption algorithm is unable to
* process the input data provided.
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the
+ * decrypted data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final byte[] doFinal(byte[] input)
@@ -2210,7 +2229,7 @@ public class Cipher {
/**
* Encrypts or decrypts data in a single-part operation, or finishes a
* multiple-part operation. The data is encrypted or decrypted,
- * depending on how this cipher was initialized.
+ * depending on how this {@code Cipher} object was initialized.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, and any input
@@ -2221,14 +2240,15 @@ public class Cipher {
* case of decryption.
* The result is stored in a new buffer.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
* @param input the input buffer
* @param inputOffset the offset in {@code input} where the input
@@ -2237,18 +2257,18 @@ public class Cipher {
*
* @return the new buffer with the result
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
* block size; or if this encryption algorithm is unable to
* process the input data provided.
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final byte[] doFinal(byte[] input, int inputOffset, int inputLen)
@@ -2268,7 +2288,7 @@ public class Cipher {
/**
* Encrypts or decrypts data in a single-part operation, or finishes a
* multiple-part operation. The data is encrypted or decrypted,
- * depending on how this cipher was initialized.
+ * depending on how this {@code Cipher} object was initialized.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, and any input
@@ -2285,14 +2305,15 @@ public class Cipher {
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
*
Note: this method should be copy-safe, which means the
* {@code input} and {@code output} buffers can reference
@@ -2307,8 +2328,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
@@ -2316,11 +2337,11 @@ public class Cipher {
* process the input data provided.
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final int doFinal(byte[] input, int inputOffset, int inputLen,
@@ -2343,7 +2364,7 @@ public class Cipher {
/**
* Encrypts or decrypts data in a single-part operation, or finishes a
* multiple-part operation. The data is encrypted or decrypted,
- * depending on how this cipher was initialized.
+ * depending on how this {@code Cipher} object was initialized.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, and any input
@@ -2362,14 +2383,15 @@ public class Cipher {
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
*
Note: this method should be copy-safe, which means the
* {@code input} and {@code output} buffers can reference
@@ -2386,8 +2408,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalBlockSizeException if this cipher is a block cipher,
* no padding has been requested (only in encryption mode), and the total
* input length of the data processed by this cipher is not a multiple of
@@ -2395,11 +2417,11 @@ public class Cipher {
* process the input data provided.
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*/
public final int doFinal(byte[] input, int inputOffset, int inputLen,
@@ -2423,7 +2445,7 @@ public class Cipher {
/**
* Encrypts or decrypts data in a single-part operation, or finishes a
* multiple-part operation. The data is encrypted or decrypted,
- * depending on how this cipher was initialized.
+ * depending on how this {@code Cipher} object was initialized.
*
*
All {@code input.remaining()} bytes starting at
* {@code input.position()} are processed.
@@ -2442,14 +2464,15 @@ public class Cipher {
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to {@code init}.
+ *
Upon finishing, this method resets this {@code Cipher} object
+ * to the state it was in when previously initialized via a call to
+ * {@code init}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code init}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code Cipher} object
+ * may need to be reset before it can be used again.
*
*
Note: this method should be copy-safe, which means the
* {@code input} and {@code output} buffers can reference
@@ -2461,8 +2484,8 @@ public class Cipher {
*
* @return the number of bytes stored in {@code output}
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
* @throws IllegalArgumentException if input and output are the
* same object
* @throws ReadOnlyBufferException if the output buffer is read-only
@@ -2473,11 +2496,11 @@ public class Cipher {
* process the input data provided.
* @throws ShortBufferException if there is insufficient space in the
* output buffer
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM/CCM), and the received authentication tag
+ * @throws BadPaddingException if this {@code Cipher} object is in
+ * decryption mode, and (un)padding has been requested, but the
+ * decrypted data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code Cipher} object is decrypting
+ * in an AEAD mode (such as GCM/CCM), and the received authentication tag
* does not match the calculated value
*
* @since 1.5
@@ -2509,7 +2532,7 @@ public class Cipher {
*
* @return the wrapped key
*
- * @throws IllegalStateException if this cipher is in a wrong
+ * @throws IllegalStateException if this {@code Cipher} object is in a wrong
* state (e.g., has not been initialized)
*
* @throws IllegalBlockSizeException if this cipher is a block
@@ -2554,8 +2577,8 @@ public class Cipher {
*
* @return the unwrapped key
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized)
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized)
*
* @throws NoSuchAlgorithmException if no installed providers
* can create keys of type {@code wrappedKeyType} for the
@@ -2654,7 +2677,7 @@ public class Cipher {
/**
* Returns an {code AlgorithmParameterSpec} object which contains
- * the maximum cipher parameter value according to the
+ * the maximum {@code Cipher} parameter value according to the
* jurisdiction policy file. If JCE unlimited strength jurisdiction
* policy files are installed or there is no maximum limit on the
* parameters for the specified transformation in the policy file,
@@ -2680,20 +2703,20 @@ public class Cipher {
* Continues a multi-part update of the Additional Authentication
* Data (AAD).
*
- * Calls to this method provide AAD to the cipher when operating in
- * modes such as AEAD (GCM/CCM). If this cipher is operating in
- * either GCM or CCM mode, all AAD must be supplied before beginning
- * operations on the ciphertext (via the {@code update} and
- * {@code doFinal} methods).
+ * Calls to this method provide AAD to the {@code Cipher} object
+ * when operating in modes such as AEAD (GCM/CCM). If this
+ * {@code Cipher} object is operating in either GCM or CCM mode, all AAD
+ * must be supplied before beginning operations on the ciphertext
+ * (via the {@code update} and {@code doFinal} methods).
*
* @param src the buffer containing the Additional Authentication Data
*
* @throws IllegalArgumentException if the {@code src}
* byte array is {@code null}
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized), does not accept AAD, or if
- * operating in either GCM or CCM mode and one of the {@code update}
- * methods has already been called for the active
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized),
+ * does not accept AAD, or if operating in either GCM or CCM mode and
+ * one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
@@ -2713,11 +2736,11 @@ public class Cipher {
* Continues a multi-part update of the Additional Authentication
* Data (AAD), using a subset of the provided buffer.
*
- * Calls to this method provide AAD to the cipher when operating in
- * modes such as AEAD (GCM/CCM). If this cipher is operating in
- * either GCM or CCM mode, all AAD must be supplied before beginning
- * operations on the ciphertext (via the {@code update}
- * and {@code doFinal} methods).
+ * Calls to this method provide AAD to the {@code Cipher} object
+ * when operating in modes such as AEAD (GCM/CCM). If this
+ * {@code Cipher} object is operating in either GCM or CCM mode,
+ * all AAD must be supplied before beginning operations on the
+ * ciphertext (via the {@code update} and {@code doFinal} methods).
*
* @param src the buffer containing the AAD
* @param offset the offset in {@code src} where the AAD input starts
@@ -2728,10 +2751,10 @@ public class Cipher {
* is less than 0, or the sum of the {@code offset} and
* {@code len} is greater than the length of the
* {@code src} byte array
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized), does not accept AAD, or if
- * operating in either GCM or CCM mode and one of the {@code update}
- * methods has already been called for the active
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized),
+ * does not accept AAD, or if operating in either GCM or CCM mode and
+ * one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
@@ -2759,11 +2782,11 @@ public class Cipher {
* Continues a multi-part update of the Additional Authentication
* Data (AAD).
*
- * Calls to this method provide AAD to the cipher when operating in
- * modes such as AEAD (GCM/CCM). If this cipher is operating in
- * either GCM or CCM mode, all AAD must be supplied before beginning
- * operations on the ciphertext (via the {@code update}
- * and {@code doFinal} methods).
+ * Calls to this method provide AAD to the {@code Cipher} object
+ * when operating in modes such as AEAD (GCM/CCM). If this
+ * {@code Cipher} object is operating in either GCM or CCM mode, all AAD
+ * must be supplied before beginning operations on the ciphertext
+ * (via the {@code update} and {@code doFinal} methods).
*
* All {@code src.remaining()} bytes starting at
* {@code src.position()} are processed.
@@ -2774,10 +2797,10 @@ public class Cipher {
*
* @throws IllegalArgumentException if the {@code src ByteBuffer}
* is {@code null}
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized), does not accept AAD, or if
- * operating in either GCM or CCM mode and one of the {@code update}
- * methods has already been called for the active
+ * @throws IllegalStateException if this {@code Cipher} object
+ * is in a wrong state (e.g., has not been initialized),
+ * does not accept AAD, or if operating in either GCM or CCM mode and
+ * one of the {@code update} methods has already been called for the active
* encryption/decryption operation
* @throws UnsupportedOperationException if the corresponding method
* in the {@code CipherSpi} has not been overridden by an
@@ -2801,14 +2824,15 @@ public class Cipher {
}
/**
- * Returns a String representation of this cipher.
+ * Returns a {@code String} representation of this {@code Cipher} object.
*
* @implNote
- * This implementation returns a String containing the transformation,
- * mode, and provider of this cipher.
- * The exact format of the String is unspecified and is subject to change.
+ * This implementation returns a {@code String} containing the
+ * transformation, mode, and provider of this {@code Cipher} object.
+ * The exact format of the {@code String} is unspecified and is subject
+ * to change.
*
- * @return a String describing this cipher
+ * @return a String describing this {@code Cipher} object
*/
@Override
public String toString() {
diff --git a/src/java.base/share/classes/javax/crypto/CipherInputStream.java b/src/java.base/share/classes/javax/crypto/CipherInputStream.java
index f6c712076a3..a7637e4b811 100644
--- a/src/java.base/share/classes/javax/crypto/CipherInputStream.java
+++ b/src/java.base/share/classes/javax/crypto/CipherInputStream.java
@@ -30,38 +30,40 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * A CipherInputStream is composed of an InputStream and a Cipher so
- * that read() methods return data that are read in from the
- * underlying InputStream but have been additionally processed by the
- * Cipher. The Cipher must be fully initialized before being used by
- * a CipherInputStream.
+ * A {@code CipherInputStream} is composed of an {@code InputStream}
+ * and a {@code Cipher} object so that read() methods return data that are
+ * read in from the underlying {@code InputStream} but have been
+ * additionally processed by the {@code Cipher} object. The {@code Cipher}
+ * object must be fully initialized before being used by a
+ * {@code CipherInputStream}.
*
- *
For example, if the Cipher is initialized for decryption, the
- * CipherInputStream will attempt to read in data and decrypt them,
- * before returning the decrypted data.
+ *
For example, if the {@code Cipher} object is initialized for decryption,
+ * the {@code CipherInputStream} will attempt to read in data and decrypt
+ * them, before returning the decrypted data.
*
*
This class adheres strictly to the semantics, especially the
* failure semantics, of its ancestor classes
- * java.io.FilterInputStream and java.io.InputStream. This class has
- * exactly those methods specified in its ancestor classes, and
+ * {@code java.io.FilterInputStream} and {@code java.io.InputStream}.
+ * This class has exactly those methods specified in its ancestor classes, and
* overrides them all. Moreover, this class catches all exceptions
* that are not thrown by its ancestor classes. In particular, the
- * skip method skips, and the available
- * method counts only data that have been processed by the encapsulated Cipher.
- * This class may catch BadPaddingException and other exceptions thrown by
- * failed integrity checks during decryption. These exceptions are not
+ * {@code skip} method skips, and the {@code available}
+ * method counts only data that have been processed by the encapsulated
+ * {@code Cipher} object.
+ * This class may catch {@code BadPaddingException} and other exceptions
+ * thrown by failed integrity checks during decryption. These exceptions are not
* re-thrown, so the client may not be informed that integrity checks
* failed. Because of this behavior, this class may not be suitable
* for use with decryption in an authenticated mode of operation (e.g. GCM).
- * Applications that require authenticated encryption can use the Cipher API
- * directly as an alternative to using this class.
+ * Applications that require authenticated encryption can use the
+ * {@code Cipher} API directly as an alternative to using this class.
*
*
It is crucial for a programmer using this class not to use
* methods that are not defined or overridden in this class (such as a
* new method or constructor that is later added to one of the super
* classes), because the design and implementation of those methods
* are unlikely to have considered security impact with regard to
- * CipherInputStream.
+ * {@code CipherInputStream}.
*
* @author Li Gong
* @see java.io.InputStream
@@ -100,7 +102,7 @@ public class CipherInputStream extends FilterInputStream {
/**
* Ensure obuffer is big enough for the next update or doFinal
- * operation, given the input length inLen (in bytes)
+ * operation, given the input length {@code inLen} (in bytes)
* The ostart and ofinish indices are reset to 0.
*
* @param inLen the input length (in bytes)
@@ -163,13 +165,13 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Constructs a CipherInputStream from an InputStream and a
- * Cipher.
+ * Constructs a {@code CipherInputStream} from an
+ * {@code InputStream} and a {@code Cipher} object.
*
Note: if the specified input stream or cipher is
- * null, a NullPointerException may be thrown later when
+ * {@code null}, a {@code NullPointerException} may be thrown later when
* they are used.
* @param is the to-be-processed input stream
- * @param c an initialized Cipher object
+ * @param c an initialized {@code Cipher} object
*/
public CipherInputStream(InputStream is, Cipher c) {
super(is);
@@ -178,11 +180,12 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Constructs a CipherInputStream from an InputStream without
- * specifying a Cipher. This has the effect of constructing a
- * CipherInputStream using a NullCipher.
- *
Note: if the specified input stream is null, a
- * NullPointerException may be thrown later when it is used.
+ * Constructs a {@code CipherInputStream} from an
+ * {@code InputStream} without specifying a {@code Cipher} object.
+ * This has the effect of constructing a {@code CipherInputStream}
+ * using a {@code NullCipher}.
+ *
Note: if the specified input stream is {@code null}, a
+ * {@code NullPointerException} may be thrown later when it is used.
* @param is the to-be-processed input stream
*/
protected CipherInputStream(InputStream is) {
@@ -193,14 +196,14 @@ public class CipherInputStream extends FilterInputStream {
/**
* Reads the next byte of data from this input stream. The value
- * byte is returned as an int in the range
- * 0 to 255. If no byte is available
+ * byte is returned as an {@code int} in the range
+ * {@code 0} to {@code 255}. If no byte is available
* because the end of the stream has been reached, the value
- * -1 is returned. This method blocks until input data
+ * {@code -1} is returned. This method blocks until input data
* is available, the end of the stream is detected, or an exception
* is thrown.
*
- * @return the next byte of data, or -1 if the end of the
+ * @return the next byte of data, or {@code -1} if the end of the
* stream is reached.
* @exception IOException if an I/O error occurs.
*/
@@ -216,16 +219,16 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Reads up to b.length bytes of data from this input
+ * Reads up to {@code b.length} bytes of data from this input
* stream into an array of bytes.
*
- * The read method of InputStream calls
- * the read method of three arguments with the arguments
- * b, 0, and b.length.
+ * The {@code read} method of {@code InputStream} calls
+ * the {@code read} method of three arguments with the arguments
+ * {@code b}, {@code 0}, and {@code b.length}.
*
* @param b the buffer into which the data is read.
* @return the total number of bytes read into the buffer, or
- * -1 is there is no more data because the end of
+ * {@code -1} is there is no more data because the end of
* the stream has been reached.
* @exception IOException if an I/O error occurs.
* @see java.io.InputStream#read(byte[], int, int)
@@ -236,17 +239,17 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Reads up to len bytes of data from this input stream
+ * Reads up to {@code len} bytes of data from this input stream
* into an array of bytes. This method blocks until some input is
- * available. If the first argument is null, up to
- * len bytes are read and discarded.
+ * available. If the first argument is {@code null}, up to
+ * {@code len} bytes are read and discarded.
*
* @param b the buffer into which the data is read.
* @param off the start offset in the destination array
- * buf
+ * {@code buf}
* @param len the maximum number of bytes read.
* @return the total number of bytes read into the buffer, or
- * -1 if there is no more data because the end of
+ * {@code -1} if there is no more data because the end of
* the stream has been reached.
* @exception IOException if an I/O error occurs.
* @see java.io.InputStream#read()
@@ -272,15 +275,15 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Skips n bytes of input from the bytes that can be read
+ * Skips {@code n} bytes of input from the bytes that can be read
* from this input stream without blocking.
*
*
Fewer bytes than requested might be skipped.
- * The actual number of bytes skipped is equal to n or
+ * The actual number of bytes skipped is equal to {@code n} or
* the result of a call to
* {@link #available() available},
* whichever is smaller.
- * If n is less than zero, no bytes are skipped.
+ * If {@code n} is less than zero, no bytes are skipped.
*
*
The actual number of bytes skipped is returned.
*
@@ -303,8 +306,8 @@ public class CipherInputStream extends FilterInputStream {
/**
* Returns the number of bytes that can be read from this input
- * stream without blocking. The available method of
- * InputStream returns 0. This method
+ * stream without blocking. The {@code available} method of
+ * {@code InputStream} returns {@code 0}. This method
* should be overridden by subclasses.
*
* @return the number of bytes that can be read from this input stream
@@ -320,8 +323,8 @@ public class CipherInputStream extends FilterInputStream {
* Closes this input stream and releases any system resources
* associated with the stream.
*
- * The close method of CipherInputStream
- * calls the close method of its underlying input
+ * The {@code close} method of {@code CipherInputStream}
+ * calls the {@code close} method of its underlying input
* stream.
*
* @exception IOException if an I/O error occurs.
@@ -350,11 +353,11 @@ public class CipherInputStream extends FilterInputStream {
}
/**
- * Tests if this input stream supports the mark
- * and reset methods, which it does not.
+ * Tests if this input stream supports the {@code mark}
+ * and {@code reset} methods, which it does not.
*
- * @return false, since this class does not support the
- * mark and reset methods.
+ * @return {@code false}, since this class does not support the
+ * {@code mark} and {@code reset} methods.
* @see java.io.InputStream#mark(int)
* @see java.io.InputStream#reset()
*/
diff --git a/src/java.base/share/classes/javax/crypto/CipherOutputStream.java b/src/java.base/share/classes/javax/crypto/CipherOutputStream.java
index daaef5d972b..48fb864dc20 100644
--- a/src/java.base/share/classes/javax/crypto/CipherOutputStream.java
+++ b/src/java.base/share/classes/javax/crypto/CipherOutputStream.java
@@ -28,36 +28,38 @@ package javax.crypto;
import java.io.*;
/**
- * A CipherOutputStream is composed of an OutputStream and a Cipher so
- * that write() methods first process the data before writing them out
- * to the underlying OutputStream. The cipher must be fully
- * initialized before being used by a CipherOutputStream.
+ * A {@code CipherOutputStream} is composed of an {@code OutputStream}
+ * and a {@code Cipher} object so that write() methods first process the data
+ * before writing them out to the underlying {@code OutputStream}.
+ * The {@code Cipher} object must be fully initialized before being used by a
+ * {@code CipherOutputStream}.
*
- *
For example, if the cipher is initialized for encryption, the
- * CipherOutputStream will attempt to encrypt data before writing out the
- * encrypted data.
+ *
For example, if the {@code Cipher} object is initialized for encryption,
+ * the {@code CipherOutputStream} will attempt to encrypt data before
+ * writing out the encrypted data.
*
*
This class adheres strictly to the semantics, especially the
* failure semantics, of its ancestor classes
- * java.io.OutputStream and java.io.FilterOutputStream. This class
- * has exactly those methods specified in its ancestor classes, and
+ * {@code java.io.OutputStream} and
+ * {@code java.io.FilterOutputStream}.
+ * This class has exactly those methods specified in its ancestor classes, and
* overrides them all. Moreover, this class catches all exceptions
* that are not thrown by its ancestor classes. In particular, this
- * class catches BadPaddingException and other exceptions thrown by
+ * class catches {@code BadPaddingException} and other exceptions thrown by
* failed integrity checks during decryption. These exceptions are not
* re-thrown, so the client will not be informed that integrity checks
* failed. Because of this behavior, this class may not be suitable
* for use with decryption in an authenticated mode of operation (e.g. GCM)
* if the application requires explicit notification when authentication
- * fails. Such an application can use the Cipher API directly as an
- * alternative to using this class.
+ * fails. Such an application can use the {@code Cipher} API directly as
+ * an alternative to using this class.
*
*
It is crucial for a programmer using this class not to use
* methods that are not defined or overridden in this class (such as a
* new method or constructor that is later added to one of the super
* classes), because the design and implementation of those methods
* are unlikely to have considered security impact with regard to
- * CipherOutputStream.
+ * {@code CipherOutputStream}.
*
* @author Li Gong
* @see java.io.OutputStream
@@ -87,7 +89,7 @@ public class CipherOutputStream extends FilterOutputStream {
/**
* Ensure obuffer is big enough for the next update or doFinal
- * operation, given the input length inLen (in bytes)
+ * operation, given the input length {@code inLen} (in bytes)
*
* @param inLen the input length (in bytes)
*/
@@ -100,14 +102,14 @@ public class CipherOutputStream extends FilterOutputStream {
/**
*
- * Constructs a CipherOutputStream from an OutputStream and a
- * Cipher.
+ * Constructs a {@code CipherOutputStream} from an
+ * {@code OutputStream} and a {@code Cipher} object.
*
Note: if the specified output stream or cipher is
- * null, a NullPointerException may be thrown later when
+ * {@code null}, {@code a NullPointerException} may be thrown later when
* they are used.
*
- * @param os the OutputStream object
- * @param c an initialized Cipher object
+ * @param os the {@code OutputStream} object
+ * @param c an initialized {@code Cipher} object
*/
public CipherOutputStream(OutputStream os, Cipher c) {
super(os);
@@ -116,13 +118,14 @@ public class CipherOutputStream extends FilterOutputStream {
}
/**
- * Constructs a CipherOutputStream from an OutputStream without
- * specifying a Cipher. This has the effect of constructing a
- * CipherOutputStream using a NullCipher.
- *
Note: if the specified output stream is null, a
- * NullPointerException may be thrown later when it is used.
+ * Constructs a {@code CipherOutputStream} from an
+ * {@code OutputStream} without specifying a {@code Cipher} object.
+ * This has the effect of constructing a {@code CipherOutputStream}
+ * using a {@code NullCipher}.
+ *
Note: if the specified output stream is {@code null}, a
+ * {@code NullPointerException} may be thrown later when it is used.
*
- * @param os the OutputStream object
+ * @param os the {@code OutputStream} object
*/
protected CipherOutputStream(OutputStream os) {
super(os);
@@ -133,7 +136,7 @@ public class CipherOutputStream extends FilterOutputStream {
/**
* Writes the specified byte to this output stream.
*
- * @param b the byte.
+ * @param b the {@code byte}.
* @exception IOException if an I/O error occurs.
*/
@Override
@@ -152,16 +155,16 @@ public class CipherOutputStream extends FilterOutputStream {
}
/**
- * Writes b.length bytes from the specified byte array
+ * Writes {@code b.length} bytes from the specified byte array
* to this output stream.
*
- * The write method of
- * CipherOutputStream calls the write
+ * The {@code write} method of
+ * {@code CipherOutputStream} calls the {@code write}
* method of three arguments with the three arguments
- * b, 0, and b.length.
+ * {@code b}, {@code 0}, and {@code b.length}.
*
* @param b the data.
- * @exception NullPointerException if b is null.
+ * @exception NullPointerException if {@code b} is {@code null}.
* @exception IOException if an I/O error occurs.
* @see javax.crypto.CipherOutputStream#write(byte[], int, int)
*/
@@ -171,8 +174,8 @@ public class CipherOutputStream extends FilterOutputStream {
}
/**
- * Writes len bytes from the specified byte array
- * starting at offset off to this output stream.
+ * Writes {@code len} bytes from the specified byte array
+ * starting at offset {@code off} to this output stream.
*
* @param b the data.
* @param off the start offset in the data.
@@ -195,14 +198,15 @@ public class CipherOutputStream extends FilterOutputStream {
/**
* Flushes this output stream by forcing any buffered output bytes
- * that have already been processed by the encapsulated cipher object
- * to be written out.
+ * that have already been processed by the encapsulated {@code Cipher}
+ * object to be written out.
*
- *
Any bytes buffered by the encapsulated cipher
+ *
Any bytes buffered by the encapsulated {@code Cipher} object
* and waiting to be processed by it will not be written out. For example,
- * if the encapsulated cipher is a block cipher, and the total number of
- * bytes written using one of the write methods is less than
- * the cipher's block size, no bytes will be written out.
+ * if the encapsulated {@code Cipher} object is a block cipher, and the
+ * total number of bytes written using one of the {@code write}
+ * methods is less than the cipher's block size, no bytes will be written
+ * out.
*
* @exception IOException if an I/O error occurs.
*/
@@ -217,14 +221,14 @@ public class CipherOutputStream extends FilterOutputStream {
* Closes this output stream and releases any system resources
* associated with this stream.
*
- * This method invokes the doFinal method of the encapsulated
- * cipher object, which causes any bytes buffered by the encapsulated
- * cipher to be processed. The result is written out by calling the
- * flush method of this output stream.
+ * This method invokes the {@code doFinal} method of the encapsulated
+ * {@code Cipher} object, which causes any bytes buffered by the
+ * encapsulated {@code Cipher} object to be processed. The result is written
+ * out by calling the {@code flush} method of this output stream.
*
- * This method resets the encapsulated cipher object to its initial state
- * and calls the close method of the underlying output
- * stream.
+ * This method resets the encapsulated {@code Cipher} object to its
+ * initial state and calls the {@code close} method of the underlying
+ * output stream.
*
* @exception IOException if an I/O error occurs.
*/
diff --git a/src/java.base/share/classes/javax/crypto/CipherSpi.java b/src/java.base/share/classes/javax/crypto/CipherSpi.java
index 6b21c16712d..d7cda476239 100644
--- a/src/java.base/share/classes/javax/crypto/CipherSpi.java
+++ b/src/java.base/share/classes/javax/crypto/CipherSpi.java
@@ -228,8 +228,8 @@ public abstract class CipherSpi {
*
* @param mode the cipher mode
*
- * @throws NoSuchAlgorithmException if the requested cipher mode does
- * not exist
+ * @throws NoSuchAlgorithmException if the requested cipher mode
+ * does not exist
*/
protected abstract void engineSetMode(String mode)
throws NoSuchAlgorithmException;
@@ -298,10 +298,11 @@ public abstract class CipherSpi {
protected abstract AlgorithmParameters engineGetParameters();
/**
- * Initializes this cipher with a key and a source
+ * Initializes this {@code CipherSpi} object with a key and a source
* of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code CipherSpi} object is initialized for one of the
+ * following four operations:
* encryption, decryption, key wrapping or key unwrapping, depending on
* the value of {@code opmode}.
*
@@ -325,13 +326,13 @@ public abstract class CipherSpi {
* requires any random bytes (e.g., for parameter generation), it will get
* them from {@code random}.
*
- *
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ *
Note that when a {@code CipherSpi} object is initialized, it loses all
+ * previously-acquired state. In other words, initializing a
+ * {@code CipherSpi} object is equivalent to creating a new instance
+ * of that {@code CipherSpi} object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of
- * the following:
+ * @param opmode the operation mode of this {@code CipherSpi} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
* {@code WRAP_MODE} or {@code UNWRAP_MODE})
* @param key the encryption key
@@ -350,10 +351,11 @@ public abstract class CipherSpi {
throws InvalidKeyException;
/**
- * Initializes this cipher with a key, a set of
+ * Initializes this {@code CipherSpi} object with a key, a set of
* algorithm parameters, and a source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code CipherSpi} object is initialized for one of the
+ * following four operations:
* encryption, decryption, key wrapping or key unwrapping, depending on
* the value of {@code opmode}.
*
@@ -377,15 +379,15 @@ public abstract class CipherSpi {
* requires any random bytes (e.g., for parameter generation), it will get
* them from {@code random}.
*
- *
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that Cipher and initializing
- * it.
+ *
Note that when a {@code CipherSpi} object is initialized, it loses all
+ * previously-acquired state. In other words, initializing a
+ * {@code CipherSpi} object is equivalent to creating a new instance of that
+ * {@code CipherSpi} object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of
- * the following:
+ * @param opmode the operation mode of this {@code CipherSpi} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
- * {@code WRAP_MODE}> or {@code UNWRAP_MODE})
+ * {@code WRAP_MODE}, or {@code UNWRAP_MODE})
* @param key the encryption key
* @param params the algorithm parameters
* @param random the source of randomness
@@ -406,10 +408,11 @@ public abstract class CipherSpi {
throws InvalidKeyException, InvalidAlgorithmParameterException;
/**
- * Initializes this cipher with a key, a set of
+ * Initializes this {@code CipherSpi} object with a key, a set of
* algorithm parameters, and a source of randomness.
*
- *
The cipher is initialized for one of the following four operations:
+ *
The {@code CipherSpi} object is initialized for one of the
+ * following four operations:
* encryption, decryption, key wrapping or key unwrapping, depending on
* the value of {@code opmode}.
*
@@ -433,15 +436,15 @@ public abstract class CipherSpi {
* requires any random bytes (e.g., for parameter generation), it will get
* them from {@code random}.
*
- *
Note that when a {@code Cipher} object is initialized, it loses all
- * previously-acquired state. In other words, initializing a cipher is
- * equivalent to creating a new instance of that cipher and initializing
- * it.
+ *
Note that when a {@code CipherSpi} object is initialized, it loses all
+ * previously-acquired state. In other words, initializing a
+ * {@code CipherSpi} object is equivalent to creating a new instance of that
+ * {@code CipherSpi} object and initializing it.
*
- * @param opmode the operation mode of this cipher (this is one of
- * the following:
+ * @param opmode the operation mode of this {@code CipherSpi} object
+ * (this is one of the following:
* {@code ENCRYPT_MODE}, {@code DECRYPT_MODE},
- * {@code WRAP_MODE} or {@code UNWRAP_MODE})
+ * {@code WRAP_MODE}, or {@code UNWRAP_MODE})
* @param key the encryption key
* @param params the algorithm parameters
* @param random the source of randomness
@@ -463,8 +466,8 @@ public abstract class CipherSpi {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code CipherSpi} object was initialized),
+ * processing another data part.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, are processed,
@@ -483,8 +486,8 @@ public abstract class CipherSpi {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code CipherSpi} object was initialized),
+ * processing another data part.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, are processed,
@@ -514,8 +517,8 @@ public abstract class CipherSpi {
/**
* Continues a multiple-part encryption or decryption operation
- * (depending on how this cipher was initialized), processing another data
- * part.
+ * (depending on how this {@code CipherSpi} object was initialized),
+ * processing another data part.
*
*
All {@code input.remaining()} bytes starting at
* {@code input.position()} are processed. The result is stored
@@ -555,8 +558,8 @@ public abstract class CipherSpi {
/**
* Encrypts or decrypts data in a single-part operation,
* or finishes a multiple-part operation.
- * The data is encrypted or decrypted, depending on how this cipher was
- * initialized.
+ * The data is encrypted or decrypted, depending on how this
+ * {@code CipherSpi} object was initialized.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, and any input
@@ -567,15 +570,15 @@ public abstract class CipherSpi {
* case of decryption.
* The result is stored in a new buffer.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to
+ *
Upon finishing, this method resets this {@code CipherSpi} object
+ * to the state it was in when previously initialized via a call to
* {@code engineInit}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code engineInit}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code CipherSpi} object
+ * may need to be reset before it can be used again.
*
* @param input the input buffer
* @param inputOffset the offset in {@code input} where the input starts
@@ -588,12 +591,12 @@ public abstract class CipherSpi {
* input length of the data processed by this cipher is not a multiple of
* block size; or if this encryption algorithm is unable to
* process the input data provided
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM or CCM), and the received authentication tag
- * does not match the calculated value
+ * @throws BadPaddingException if this {@code CipherSpi} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code CipherSpi} object is
+ * decrypting in an AEAD mode (such as GCM or CCM), and the received
+ * authentication tag does not match the calculated value
*/
protected abstract byte[] engineDoFinal(byte[] input, int inputOffset,
int inputLen)
@@ -602,8 +605,8 @@ public abstract class CipherSpi {
/**
* Encrypts or decrypts data in a single-part operation,
* or finishes a multiple-part operation.
- * The data is encrypted or decrypted, depending on how this cipher was
- * initialized.
+ * The data is encrypted or decrypted, depending on how this
+ * {@code CipherSpi} object was initialized.
*
*
The first {@code inputLen} bytes in the {@code input}
* buffer, starting at {@code inputOffset} inclusive, and any input
@@ -618,15 +621,15 @@ public abstract class CipherSpi {
*
If the {@code output} buffer is too small to hold the result,
* a {@code ShortBufferException} is thrown.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to
+ *
Upon finishing, this method resets this {@code CipherSpi} object
+ * to the state it was in when previously initialized via a call to
* {@code engineInit}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code engineInit}) more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code CipherSpi} object
+ * may need to be reset before it can be used again.
*
* @param input the input buffer
* @param inputOffset the offset in {@code input} where the input
@@ -645,12 +648,13 @@ public abstract class CipherSpi {
* process the input data provided
* @throws ShortBufferException if the given output buffer is too small
* to hold the result
- * @throws BadPaddingException if this cipher is in decryption mode,
+ * @throws BadPaddingException if this {@code CipherSpi} object is in
+ * decryption mode,
* and (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM or CCM), and the received authentication tag
- * does not match the calculated value
+ * @throws AEADBadTagException if this {@code CipherSpi} object is
+ * decrypting in an AEAD mode (such as GCM or CCM), and the received
+ * authentication tag does not match the calculated value
*/
protected abstract int engineDoFinal(byte[] input, int inputOffset,
int inputLen, byte[] output,
@@ -661,8 +665,8 @@ public abstract class CipherSpi {
/**
* Encrypts or decrypts data in a single-part operation,
* or finishes a multiple-part operation.
- * The data is encrypted or decrypted, depending on how this cipher was
- * initialized.
+ * The data is encrypted or decrypted, depending on how this
+ * {@code CipherSpi} object was initialized.
*
*
All {@code input.remaining()} bytes starting at
* {@code input.position()} are processed.
@@ -678,15 +682,15 @@ public abstract class CipherSpi {
*
If {@code output.remaining()} bytes are insufficient to
* hold the result, a {@code ShortBufferException} is thrown.
*
- *
Upon finishing, this method resets this cipher to the state
- * it was in when previously initialized via a call to
+ *
Upon finishing, this method resets this {@code CipherSpi} object
+ * to the state it was in when previously initialized via a call to
* {@code engineInit}.
* That is, the object is reset and available to encrypt or decrypt
* (depending on the operation mode that was specified in the call to
* {@code engineInit} more data.
*
- *
Note: if any exception is thrown, this cipher may need to
- * be reset before it can be used again.
+ *
Note: if any exception is thrown, this {@code CipherSpi} object
+ * may need to be reset before it can be used again.
*
*
Subclasses should consider overriding this method if they can
* process ByteBuffers more efficiently than byte arrays.
@@ -703,12 +707,12 @@ public abstract class CipherSpi {
* process the input data provided
* @throws ShortBufferException if there is insufficient space in the
* output buffer
- * @throws BadPaddingException if this cipher is in decryption mode,
- * and (un)padding has been requested, but the decrypted data is not
- * bounded by the appropriate padding bytes
- * @throws AEADBadTagException if this cipher is decrypting in an
- * AEAD mode (such as GCM or CCM), and the received authentication tag
- * does not match the calculated value
+ * @throws BadPaddingException if this {@code CipherSpi} object is in
+ * decryption mode, and (un)padding has been requested, but the decrypted
+ * data is not bounded by the appropriate padding bytes
+ * @throws AEADBadTagException if this {@code CipherSpi} object is
+ * decrypting in an AEAD mode (such as GCM or CCM), and the received
+ * authentication tag does not match the calculated value
*
* @throws NullPointerException if either parameter is {@code null}
* @since 1.5
@@ -935,10 +939,10 @@ public abstract class CipherSpi {
* @param offset the offset in {@code src} where the AAD input starts
* @param len the number of AAD bytes
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized), does not accept AAD, or if
- * operating in either GCM or CCM mode and one of the {@code update}
- * methods has already been called for the active
+ * @throws IllegalStateException if this {@code CipherSpi} object is in
+ * a wrong state (e.g., has not been initialized), does not accept AAD,
+ * or if operating in either GCM or CCM mode and one of the
+ * {@code update} methods has already been called for the active
* encryption/decryption operation
* @throws UnsupportedOperationException if this method
* has not been overridden by an implementation
@@ -968,10 +972,10 @@ public abstract class CipherSpi {
*
* @param src the buffer containing the AAD
*
- * @throws IllegalStateException if this cipher is in a wrong state
- * (e.g., has not been initialized), does not accept AAD, or if
- * operating in either GCM or CCM mode and one of the {@code update}
- * methods has already been called for the active
+ * @throws IllegalStateException if this {@code CipherSpi} object is in
+ * a wrong state (e.g., has not been initialized), does not accept AAD,
+ * or if operating in either GCM or CCM mode and one of the
+ * {@code update} methods has already been called for the active
* encryption/decryption operation
* @throws UnsupportedOperationException if this method
* has not been overridden by an implementation
diff --git a/src/java.base/share/classes/javax/crypto/CryptoAllPermission.java b/src/java.base/share/classes/javax/crypto/CryptoAllPermission.java
index 4d579afd1e8..99829d5907e 100644
--- a/src/java.base/share/classes/javax/crypto/CryptoAllPermission.java
+++ b/src/java.base/share/classes/javax/crypto/CryptoAllPermission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2022, 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
@@ -60,20 +60,21 @@ final class CryptoAllPermission extends CryptoPermission {
*
* @param p the permission to check against.
*
- * @return true if the specified permission is an
- * instance of CryptoPermission.
+ * @return {@code true} if the specified permission is an
+ * instance of {@code CryptoPermission}.
*/
public boolean implies(Permission p) {
return (p instanceof CryptoPermission);
}
/**
- * Checks two CryptoAllPermission objects for equality.
- * Two CryptoAllPermission objects are always equal.
+ * Checks two {@code CryptoAllPermission} objects for equality.
+ * Two {@code CryptoAllPermission} objects are always equal.
*
* @param obj the object to test for equality with this object.
*
- * @return true if obj is a CryptoAllPermission object.
+ * @return {@code true} if obj is a
+ * {@code CryptoAllPermission} object.
*/
public boolean equals(Object obj) {
return (obj == INSTANCE);
@@ -90,12 +91,11 @@ final class CryptoAllPermission extends CryptoPermission {
}
/**
- * Returns a new PermissionCollection object for storing
- * CryptoAllPermission objects.
- *
+ * Returns a new {@code PermissionCollection} object for storing
+ * {@code CryptoAllPermission} objects.
*
- * @return a new PermissionCollection object suitable for
- * storing CryptoAllPermissions.
+ * @return a new {@code PermissionCollection} object suitable for
+ * storing {@code CryptoAllPermission} objects.
*/
public PermissionCollection newPermissionCollection() {
return new CryptoAllPermissionCollection();
@@ -103,8 +103,8 @@ final class CryptoAllPermission extends CryptoPermission {
}
/**
- * A CryptoAllPermissionCollection stores a collection
- * of CryptoAllPermission permissions.
+ * A {@code CryptoAllPermissionCollection} stores a collection
+ * of {@code CryptoAllPermission} objects.
*
* @see java.security.Permission
* @see java.security.Permissions
@@ -123,18 +123,18 @@ final class CryptoAllPermissionCollection extends PermissionCollection
private boolean all_allowed;
/**
- * Create an empty CryptoAllPermissions object.
+ * Create an empty {@code CryptoAllPermission} object.
*/
CryptoAllPermissionCollection() {
all_allowed = false;
}
/**
- * Adds a permission to the CryptoAllPermissions.
+ * Adds a permission to {@code CryptoAllPermission} object.
*
- * @param permission the Permission object to add.
+ * @param permission the {@code Permission} object to add.
*
- * @exception SecurityException - if this CryptoAllPermissionCollection
+ * @exception SecurityException if this {@code CryptoAllPermissionCollection}
* object has been marked readonly
*/
public void add(Permission permission) {
@@ -152,10 +152,10 @@ final class CryptoAllPermissionCollection extends PermissionCollection
* Check and see if this set of permissions implies the permissions
* expressed in "permission".
*
- * @param permission the Permission object to compare
+ * @param permission the {@code Permission} object to compare
*
- * @return true if the given permission is implied by this
- * CryptoAllPermissionCollection.
+ * @return {@code true} if the given permission is implied by this
+ * {@code CryptoAllPermissionCollection} object.
*/
public boolean implies(Permission permission) {
if (!(permission instanceof CryptoPermission)) {
@@ -165,10 +165,10 @@ final class CryptoAllPermissionCollection extends PermissionCollection
}
/**
- * Returns an enumeration of all the CryptoAllPermission
- * objects in the container.
+ * Returns an enumeration of all the {@code CryptoAllPermission}
+ * objects in the container.
*
- * @return an enumeration of all the CryptoAllPermission objects.
+ * @return an enumeration of all {@code CryptoAllPermission} objects.
*/
public Enumeration elements() {
Vector v = new Vector<>(1);
diff --git a/src/java.base/share/classes/javax/crypto/CryptoPermission.java b/src/java.base/share/classes/javax/crypto/CryptoPermission.java
index 5a00782b401..e92e9abdf91 100644
--- a/src/java.base/share/classes/javax/crypto/CryptoPermission.java
+++ b/src/java.base/share/classes/javax/crypto/CryptoPermission.java
@@ -35,9 +35,9 @@ import java.util.Vector;
import javax.crypto.spec.*;
/**
- * The CryptoPermission class extends the
- * java.security.Permission class. A
- * CryptoPermission object is used to represent
+ * The {@code CryptoPermission} class extends the
+ * {@code java.security.Permission} class. A
+ * {@code CryptoPermission} object is used to represent
* the ability of an application/applet to use certain
* algorithms with certain key sizes and other
* restrictions in certain environments.
@@ -80,7 +80,7 @@ class CryptoPermission extends java.security.Permission {
* key size.
*
* This constructor implies that the given algorithm can be
- * used with a key size up to maxKeySize.
+ * used with a key size up to {@code maxKeySize}.
*
* @param alg the algorithm name.
*
@@ -95,12 +95,12 @@ class CryptoPermission extends java.security.Permission {
/**
* Constructor that takes an algorithm name, a maximum
- * key size, and an AlgorithmParameterSpec object.
+ * key size, and an {@code AlgorithmParameterSpec} object.
*
* This constructor implies that the given algorithm can be
- * used with a key size up to maxKeySize, and
+ * used with a key size up to {@code maxKeySize}, and
* algorithm
- * parameters up to the limits set in algParamSpec.
+ * parameters up to the limits set in {@code algParamSpec}.
*
* @param alg the algorithm name.
*
@@ -144,7 +144,7 @@ class CryptoPermission extends java.security.Permission {
* size, and the name of an exemption mechanism.
*
* This constructor implies that the given algorithm can be
- * used with a key size up to maxKeySize
+ * used with a key size up to {@code maxKeySize}
* provided that the
* specified exemption mechanism is enforced.
*
@@ -166,12 +166,12 @@ class CryptoPermission extends java.security.Permission {
/**
* Constructor that takes an algorithm name, a maximum key
* size, the name of an exemption mechanism, and an
- * AlgorithmParameterSpec object.
+ * {@code AlgorithmParameterSpec} object.
*
* This constructor implies that the given algorithm can be
- * used with a key size up to maxKeySize
+ * used with a key size up to {@code maxKeySize}
* and algorithm
- * parameters up to the limits set in algParamSpec
+ * parameters up to the limits set in {@code algParamSpec}
* provided that
* the specified exemption mechanism is enforced.
*
@@ -199,9 +199,9 @@ class CryptoPermission extends java.security.Permission {
* Checks if the specified permission is "implied" by
* this object.
*
- * More specifically, this method returns true if:
+ * More specifically, this method returns {@code true} if:
*
- * - p is an instance of CryptoPermission, and
+ * - p is an instance of {@code CryptoPermission}, and
* - p's algorithm name equals or (in the case of wildcards)
* is implied by this permission's algorithm name, and
* - p's maximum allowable key size is less or
@@ -210,14 +210,14 @@ class CryptoPermission extends java.security.Permission {
* implied by this permission's algorithm parameter spec, and
* - p's exemptionMechanism equals or
* is implied by this permission's
- * exemptionMechanism (a
null exemption mechanism
+ * exemptionMechanism (a {@code null} exemption mechanism
* implies any other exemption mechanism).
*
*
* @param p the permission to check against.
*
- * @return true if the specified permission is equal to or
- * implied by this permission, false otherwise.
+ * @return {@code true} if the specified permission is equal to or
+ * implied by this permission, {@code false} otherwise.
*/
public boolean implies(Permission p) {
if (!(p instanceof CryptoPermission cp))
@@ -244,15 +244,13 @@ class CryptoPermission extends java.security.Permission {
}
/**
- * Checks two CryptoPermission objects for equality. Checks that
- * obj is a CryptoPermission, and has the same
- * algorithm name,
+ * Checks two {@code CryptoPermission} objects for equality.
+ * Checks that {@code obj} is a {@code CryptoPermission}
+ * object, and has the same algorithm name,
* exemption mechanism name, maximum allowable key size and
- * algorithm parameter spec
- * as this object.
- *
+ * algorithm parameter spec as this object.
* @param obj the object to test for equality with this object.
- * @return true if obj is equal to this object.
+ * @return {@code true} if {@code obj} is equal to this object.
*/
public boolean equals(Object obj) {
if (obj == this)
@@ -294,7 +292,7 @@ class CryptoPermission extends java.security.Permission {
}
/**
- * There is no action defined for a CryptoPermission
+ * There is no action defined for a {@code CryptoPermission}
* object.
*/
public String getActions()
@@ -303,10 +301,10 @@ class CryptoPermission extends java.security.Permission {
}
/**
- * Returns a new PermissionCollection object for storing
- * CryptoPermission objects.
+ * Returns a new {@code PermissionCollection} object for storing
+ * {@code CryptoPermission} objects.
*
- * @return a new PermissionCollection object suitable for storing
+ * @return a new {@code PermissionCollection} object suitable for storing
* CryptoPermissions.
*/
@@ -316,7 +314,7 @@ class CryptoPermission extends java.security.Permission {
/**
* Returns the algorithm name associated with
- * this CryptoPermission object.
+ * this {@code CryptoPermission} object.
*/
final String getAlgorithm() {
return alg;
@@ -324,7 +322,7 @@ class CryptoPermission extends java.security.Permission {
/**
* Returns the exemption mechanism name
- * associated with this CryptoPermission
+ * associated with this {@code CryptoPermission}
* object.
*/
final String getExemptionMechanism() {
@@ -333,16 +331,16 @@ class CryptoPermission extends java.security.Permission {
/**
* Returns the maximum allowable key size associated
- * with this CryptoPermission object.
+ * with this {@code CryptoPermission} object.
*/
final int getMaxKeySize() {
return maxKeySize;
}
/**
- * Returns true if there is a limitation on the
- * AlgorithmParameterSpec associated with this
- * CryptoPermission object and false if otherwise.
+ * Returns {@code true} if there is a limitation on the
+ * {@code AlgorithmParameterSpec} associated with this
+ * {@code CryptoPermission} object and {@code false} if otherwise.
*/
final boolean getCheckParam() {
return checkParam;
@@ -358,12 +356,13 @@ class CryptoPermission extends java.security.Permission {
}
/**
- * Returns a string describing this CryptoPermission. The convention is to
- * specify the class name, the algorithm name, the maximum allowable
- * key size, and the name of the exemption mechanism, in the following
+ * Returns a string describing this {@code CryptoPermission} object.
+ * The convention is to specify the class name, the algorithm name,
+ * the maximum allowable key size, and the name of the exemption mechanism,
+ * in the following
* format: '("ClassName" "algorithm" "keysize" "exemption_mechanism")'.
*
- * @return information about this CryptoPermission.
+ * @return information about this {@code CryptoPermission} object.
*/
public String toString() {
StringBuilder buf = new StringBuilder(100);
@@ -449,8 +448,8 @@ class CryptoPermission extends java.security.Permission {
}
/**
- * A CryptoPermissionCollection stores a set of CryptoPermission
- * permissions.
+ * A {@code CryptoPermissionCollection} object stores a set of
+ * {@code CryptoPermission} objects.
*
* @see java.security.Permission
* @see java.security.Permissions
@@ -475,12 +474,13 @@ final class CryptoPermissionCollection extends PermissionCollection
}
/**
- * Adds a permission to the CryptoPermissionCollection.
+ * Adds a permission to the {@code CryptoPermissionCollection} object.
*
- * @param permission the Permission object to add.
+ * @param permission the {@code Permission} object to add.
*
- * @exception SecurityException - if this CryptoPermissionCollection
- * object has been marked readOnly.
+ * @exception SecurityException if this
+ * {@code CryptoPermissionCollection} object has been marked
+ * readOnly.
*/
public void add(Permission permission) {
if (isReadOnly())
@@ -494,13 +494,13 @@ final class CryptoPermissionCollection extends PermissionCollection
}
/**
- * Check and see if this CryptoPermission object implies
- * the given Permission object.
+ * Check and see if this {@code CryptoPermission} object implies
+ * the given {@code Permission} object.
*
- * @param permission the Permission object to compare
+ * @param permission the {@code Permission} object to compare
*
- * @return true if the given permission is implied by this
- * CryptoPermissionCollection, false if not.
+ * @return {@code true} if the given permission is implied by this
+ * {@code CryptoPermissionCollection}, {@code false} if not.
*/
public boolean implies(Permission permission) {
if (!(permission instanceof CryptoPermission cp))
@@ -518,10 +518,10 @@ final class CryptoPermissionCollection extends PermissionCollection
}
/**
- * Returns an enumeration of all the CryptoPermission objects
+ * Returns an enumeration of all the {@code CryptoPermission} objects
* in the container.
*
- * @return an enumeration of all the CryptoPermission objects.
+ * @return an enumeration of all the {@code CryptoPermission} objects.
*/
public Enumeration elements() {
diff --git a/src/java.base/share/classes/javax/crypto/CryptoPermissions.java b/src/java.base/share/classes/javax/crypto/CryptoPermissions.java
index 52a7ae2dd75..d5a34d0944a 100644
--- a/src/java.base/share/classes/javax/crypto/CryptoPermissions.java
+++ b/src/java.base/share/classes/javax/crypto/CryptoPermissions.java
@@ -43,17 +43,17 @@ import java.io.IOException;
import static java.nio.charset.StandardCharsets.UTF_8;
/**
- * This class contains CryptoPermission objects, organized into
- * PermissionCollections according to algorithm names.
+ * This class contains {@code CryptoPermission} objects, organized into
+ * {@code PermissionCollection} objects according to algorithm names.
*
- * When the add method is called to add a
- * CryptoPermission, the CryptoPermission is stored in the
- * appropriate PermissionCollection. If no such
+ *
When the {@code add} method is called to add a
+ * {@code CryptoPermission}, the {@code CryptoPermission} is stored in the
+ * appropriate {@code PermissionCollection}. If no such
* collection exists yet, the algorithm name associated with
- * the CryptoPermission object is
- * determined and the newPermissionCollection method
- * is called on the CryptoPermission or CryptoAllPermission class to
- * create the PermissionCollection and add it to the Permissions object.
+ * the {@code CryptoPermission} object is
+ * determined and the {@code newPermissionCollection} method
+ * is called on the {@code CryptoPermission} or {@code CryptoAllPermission} class to
+ * create the {@code PermissionCollection} and add it to the {@code Permissions} object.
*
* @see javax.crypto.CryptoPermission
* @see java.security.PermissionCollection
@@ -82,8 +82,8 @@ implements Serializable {
private transient ConcurrentHashMap perms;
/**
- * Creates a new CryptoPermissions object containing
- * no CryptoPermissionCollections.
+ * Creates a new {@code CryptoPermissions} object containing
+ * no {@code CryptoPermissionCollection} objects.
*/
CryptoPermissions() {
perms = new ConcurrentHashMap<>(7);
@@ -91,7 +91,7 @@ implements Serializable {
/**
* Populates the crypto policy from the specified
- * InputStream into this CryptoPermissions object.
+ * {@code InputStream} into this {@code CryptoPermissions} object.
*
* @param in the InputStream to load from.
*
@@ -110,29 +110,29 @@ implements Serializable {
}
/**
- * Returns true if this CryptoPermissions object doesn't
- * contain any CryptoPermission objects; otherwise, returns
- * false.
+ * Returns {@code true} if this {@code CryptoPermissions} object doesn't
+ * contain any {@code CryptoPermission} objects; otherwise, returns
+ * {@code false}.
*/
boolean isEmpty() {
return perms.isEmpty();
}
/**
- * Adds a permission object to the PermissionCollection for the
- * algorithm returned by
- * (CryptoPermission)permission.getAlgorithm().
+ * Adds a permission object to the
+ * {@code PermissionCollection} for the algorithm returned by
+ * {@code (CryptoPermission)permission.getAlgorithm()}.
*
* This method creates
- * a new PermissionCollection object (and adds the permission to it)
- * if an appropriate collection does not yet exist.
+ * a new {@code PermissionCollection} object (and adds the
+ * permission to it) if an appropriate collection does not yet exist.
*
- * @param permission the Permission object to add.
+ * @param permission the {@code Permission} object to add.
*
- * @exception SecurityException if this CryptoPermissions object is
- * marked as readonly.
+ * @exception SecurityException if this {@code CryptoPermissions}
+ * object is marked as readonly.
*
- * @see isReadOnly
+ * @see PermissionCollection#isReadOnly
*/
@Override
public void add(Permission permission) {
@@ -155,14 +155,14 @@ implements Serializable {
}
/**
- * Checks if this object's PermissionCollection for permissions
+ * Checks if this object's {@code PermissionCollection} for permissions
* of the specified permission's algorithm implies the specified
- * permission. Returns true if the checking succeeded.
+ * permission. Returns {@code true} if the checking succeeded.
*
- * @param permission the Permission object to check.
+ * @param permission the {@code Permission} object to check.
*
- * @return true if "permission" is implied by the permissions
- * in the PermissionCollection it belongs to, false if not.
+ * @return {@code true} if {@code permission} is implied by the permissions
+ * in the {@code PermissionCollection} it belongs to, {@code false} if not.
*
*/
@Override
@@ -183,10 +183,9 @@ implements Serializable {
}
/**
- * Returns an enumeration of all the Permission objects in all the
- * PermissionCollections in this CryptoPermissions object.
- *
- * @return an enumeration of all the Permissions.
+ * Returns an enumeration of all the {@code Permission} objects
+ * in this {@code CryptoPermissions} object.
+ * @return an enumeration of all the {@code Permission} objects.
*/
@Override
public Enumeration elements() {
@@ -196,12 +195,12 @@ implements Serializable {
}
/**
- * Returns a CryptoPermissions object which
+ * Returns a {@code CryptoPermissions} object which
* represents the minimum of the specified
- * CryptoPermissions object and this
- * CryptoPermissions object.
+ * {@code CryptoPermissions} object and this
+ * {@code CryptoPermissions} object.
*
- * @param other the CryptoPermission
+ * @param other the {@code CryptoPermission}
* object to compare with this object.
*/
CryptoPermissions getMinimum(CryptoPermissions other) {
@@ -293,13 +292,13 @@ implements Serializable {
}
/**
- * Get the minimum of the two given PermissionCollection
- * thisPc and thatPc.
+ * Get the minimum of the two given {@code PermissionCollection}
+ * {@code thisPc} and {@code thatPc}.
*
- * @param thisPc the first given PermissionCollection
+ * @param thisPc the first given {@code PermissionCollection}
* object.
*
- * @param thatPc the second given PermissionCollection
+ * @param thatPc the second given {@code PermissionCollection}
* object.
*/
private CryptoPermission[] getMinimum(PermissionCollection thisPc,
@@ -344,17 +343,18 @@ implements Serializable {
}
/**
- * Returns all the CryptoPermission objects in the given
- * PermissionCollection object
- * whose maximum keysize no greater than maxKeySize.
- * For all CryptoPermission objects with a maximum keysize greater
- * than maxKeySize, this method constructs a
- * corresponding CryptoPermission object whose maximum keysize is
- * set to maxKeySize, and includes that in the result.
+ * Returns all the {@code CryptoPermission} objects in the given
+ * {@code PermissionCollection} object
+ * whose maximum keysize no greater than {@code maxKeySize}.
+ * For all {@code CryptoPermission} objects with a maximum keysize
+ * greater than {@code maxKeySize}, this method constructs a
+ * corresponding {@code CryptoPermission} object whose maximum
+ * keysize is set to {@code maxKeySize}, and includes that in
+ * the result.
*
* @param maxKeySize the given maximum key size.
*
- * @param pc the given PermissionCollection object.
+ * @param pc the given {@code PermissionCollection} object.
*/
private CryptoPermission[] getMinimum(int maxKeySize,
PermissionCollection pc) {
@@ -387,9 +387,9 @@ implements Serializable {
}
/**
- * Returns the PermissionCollection for the
- * specified algorithm. Returns null if there
- * isn't such a PermissionCollection.
+ * Returns the {@code PermissionCollection} for the
+ * specified algorithm. Returns {@code null} if there
+ * isn't such a {@code PermissionCollection}.
*
* @param alg the algorithm name.
*/
@@ -412,13 +412,13 @@ implements Serializable {
}
/**
- * Returns the PermissionCollection for the algorithm
- * associated with the specified CryptoPermission
- * object. Creates such a PermissionCollection
- * if such a PermissionCollection does not
+ * Returns the {@code PermissionCollection} for the algorithm
+ * associated with the specified {@code CryptoPermission}
+ * object. Creates such a {@code PermissionCollection}
+ * if such a {@code PermissionCollection} does not
* exist yet.
*
- * @param cryptoPerm the CryptoPermission object.
+ * @param cryptoPerm the {@code CryptoPermission} object.
*/
private PermissionCollection getPermissionCollection(
CryptoPermission cryptoPerm) {
diff --git a/src/java.base/share/classes/javax/crypto/CryptoPolicyParser.java b/src/java.base/share/classes/javax/crypto/CryptoPolicyParser.java
index 2ca1537f74b..fc984a13d14 100644
--- a/src/java.base/share/classes/javax/crypto/CryptoPolicyParser.java
+++ b/src/java.base/share/classes/javax/crypto/CryptoPolicyParser.java
@@ -42,8 +42,9 @@ import java.lang.reflect.*;
* JCE will be used.
*
* The jurisdiction policy file has the same syntax as JDK policy files except
- * that JCE has new permission classes called javax.crypto.CryptoPermission
- * and javax.crypto.CryptoAllPermission.
+ * that JCE has new permission classes called
+ * {@code javax.crypto.CryptoPermission} and
+ * {@code javax.crypto.CryptoAllPermission}.
*
* The format of a permission entry in the jurisdiction policy file is:
*
@@ -74,16 +75,16 @@ final class CryptoPolicyParser {
private boolean allPermEntryFound = false;
/**
- * Creates a CryptoPolicyParser object.
+ * Creates a {@code CryptoPolicyParser} object.
*/
CryptoPolicyParser() {
grantEntries = new Vector<>();
}
/**
- * Reads a policy configuration using a Reader object.
+ * Reads a policy configuration using a {@code Reader} object.
*
- * @param policy the policy Reader object.
+ * @param policy the policy {@code Reader} object.
*
* @exception ParsingException if the policy configuration
* contains a syntax error.
@@ -537,8 +538,8 @@ final class CryptoPolicyParser {
}
/**
- * Each grant entry in the policy configuration file is represented by a
- * GrantEntry object.
+ * Each grant entry in the policy configuration file is represented by a
+ * {@code GrantEntry} object.
*
* For example, the entry
*
@@ -588,7 +589,7 @@ final class CryptoPolicyParser {
}
/**
- * Enumerate all the permission entries in this GrantEntry.
+ * Enumerate all the permission entries in this {@code GrantEntry}.
*/
Enumeration permissionElements(){
return permissionEntries.elements();
@@ -598,7 +599,7 @@ final class CryptoPolicyParser {
/**
* Each crypto permission entry in the policy configuration file is
- * represented by a CryptoPermissionEntry object.
+ * represented by a {@code CryptoPermissionEntry} object.
*
* For example, the entry
*
@@ -692,7 +693,7 @@ final class CryptoPolicyParser {
private static final long serialVersionUID = 7147241245566588374L;
/**
- * Constructs a ParsingException with the specified
+ * Constructs a {@code ParsingException} with the specified
* detail message.
* @param msg the detail message.
*/
diff --git a/src/java.base/share/classes/javax/crypto/EncryptedPrivateKeyInfo.java b/src/java.base/share/classes/javax/crypto/EncryptedPrivateKeyInfo.java
index ade1aeb3d86..4ed8b74623a 100644
--- a/src/java.base/share/classes/javax/crypto/EncryptedPrivateKeyInfo.java
+++ b/src/java.base/share/classes/javax/crypto/EncryptedPrivateKeyInfo.java
@@ -34,7 +34,7 @@ import sun.security.util.DerInputStream;
import sun.security.util.DerOutputStream;
/**
- * This class implements the EncryptedPrivateKeyInfo type
+ * This class implements the {@code EncryptedPrivateKeyInfo} type
* as defined in PKCS #8.
* Its ASN.1 definition is as follows:
*
@@ -70,11 +70,12 @@ public class EncryptedPrivateKeyInfo {
private byte[] encoded;
/**
- * Constructs (i.e., parses) an EncryptedPrivateKeyInfo from
+ * Constructs (i.e., parses) an {@code EncryptedPrivateKeyInfo} from
* its ASN.1 encoding.
* @param encoded the ASN.1 encoding of this object. The contents of
* the array are copied to protect against subsequent modification.
- * @exception NullPointerException if the encoded is null.
+ * @exception NullPointerException if the {@code encoded} is
+ * {@code null}.
* @exception IOException if error occurs when parsing the ASN.1 encoding.
*/
public EncryptedPrivateKeyInfo(byte[] encoded) throws IOException {
@@ -110,12 +111,12 @@ public class EncryptedPrivateKeyInfo {
}
/**
- * Constructs an EncryptedPrivateKeyInfo from the
+ * Constructs an {@code EncryptedPrivateKeyInfo} from the
* encryption algorithm name and the encrypted data.
*
- *
Note: This constructor will use null as the value of the
+ *
Note: This constructor will use {@code null} as the value of the
* algorithm parameters. If the encryption algorithm has
- * parameters whose value is not null, a different constructor,
+ * parameters whose value is not {@code null}, a different constructor,
* e.g. EncryptedPrivateKeyInfo(AlgorithmParameters, byte[]),
* should be used.
*
@@ -124,11 +125,11 @@ public class EncryptedPrivateKeyInfo {
* Java Security Standard Algorithm Names
document
* for information about standard Cipher algorithm names.
* @param encryptedData encrypted data. The contents of
- * This method traverses the list of registered security Providers,
- * starting with the most preferred Provider.
- * A new ExemptionMechanism object encapsulating the
- * ExemptionMechanismSpi implementation from the first
- * Provider that supports the specified algorithm is returned.
+ *
This method traverses the list of registered security providers,
+ * starting with the most preferred provider.
+ * A new {@code ExemptionMechanism} object encapsulating the
+ * {@code ExemptionMechanismSpi} implementation from the first
+ * provider that supports the specified algorithm is returned.
*
*
Note that the list of registered providers may be retrieved via
* the {@link Security#getProviders() Security.getProviders()} method.
@@ -150,12 +150,12 @@ public class ExemptionMechanism {
/**
- * Returns an ExemptionMechanism object that implements the
+ * Returns an {@code ExemptionMechanism} object that implements the
* specified exemption mechanism algorithm.
*
- *
A new ExemptionMechanism object encapsulating the
- * ExemptionMechanismSpi implementation from the specified provider
- * is returned. The specified provider must be registered
+ *
A new {@code ExemptionMechanism} object encapsulating the
+ * {@code ExemptionMechanismSpi} implementation from the specified
+ * provider is returned. The specified provider must be registered
* in the security provider list.
*
*
Note that the list of registered providers may be retrieved via
@@ -197,12 +197,12 @@ public class ExemptionMechanism {
}
/**
- * Returns an ExemptionMechanism object that implements the
+ * Returns an {@code ExemptionMechanism} object that implements the
* specified exemption mechanism algorithm.
*
- *
A new ExemptionMechanism object encapsulating the
- * ExemptionMechanismSpi implementation from the specified Provider
- * object is returned. Note that the specified Provider object
+ *
A new {@code ExemptionMechanism} object encapsulating the
+ * {@code ExemptionMechanismSpi} implementation from the specified
+ * provider object is returned. Note that the specified provider object
* does not have to be registered in the provider list.
*
* @param algorithm the standard name of the requested exemption mechanism.
@@ -217,11 +217,11 @@ public class ExemptionMechanism {
* @return the new {@code ExemptionMechanism} object
*
* @throws IllegalArgumentException if the {@code provider}
- * is null
+ * is {@code null}
*
* @throws NoSuchAlgorithmException if an {@code ExemptionMechanismSpi}
* implementation for the specified algorithm is not available
- * from the specified {@code Provider object}
+ * from the specified {@code Provider} object
*
* @exception NullPointerException if {@code algorithm} is {@code null}
*
@@ -237,9 +237,9 @@ public class ExemptionMechanism {
}
/**
- * Returns the provider of this ExemptionMechanism object.
+ * Returns the provider of this {@code ExemptionMechanism} object.
*
- * @return the provider of this ExemptionMechanism object.
+ * @return the provider of this {@code ExemptionMechanism} object.
*/
public final Provider getProvider() {
return this.provider;
@@ -256,8 +256,8 @@ public class ExemptionMechanism {
* @param key the key the crypto is going to use.
*
* @return whether the result blob of the same key has been generated
- * successfully by this exemption mechanism; false if key
- * is null.
+ * successfully by this exemption mechanism; {@code false} if {@code key}
+ * is {@code null}.
*
* @exception ExemptionMechanismException if problem(s) encountered
* while determining whether the result blob has been generated successfully
@@ -278,7 +278,7 @@ public class ExemptionMechanism {
* Returns the length in bytes that an output buffer would need to be in
* order to hold the result of the next
* {@link #genExemptionBlob(byte[]) genExemptionBlob}
- * operation, given the input length inputLen (in bytes).
+ * operation, given the input length {@code inputLen} (in bytes).
*
*
The actual output length of the next
* {@link #genExemptionBlob(byte[]) genExemptionBlob}
@@ -307,11 +307,11 @@ public class ExemptionMechanism {
* Initializes this exemption mechanism with a key.
*
*
If this exemption mechanism requires any algorithm parameters
- * that cannot be derived from the given key, the
+ * that cannot be derived from the given {@code key}, the
* underlying exemption mechanism implementation is supposed to
* generate the required parameters itself (using provider-specific
* default values); in the case that algorithm parameters must be
- * specified by the caller, an InvalidKeyException is raised.
+ * specified by the caller, an {@code InvalidKeyException} is raised.
*
* @param key the key for this exemption mechanism
*
@@ -335,11 +335,11 @@ public class ExemptionMechanism {
* parameters.
*
*
If the {@code output} buffer is too small to hold the result,
+ * a {@code ShortBufferException} is thrown. In this case, repeat this
* call with a larger output buffer. Use
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
* @param output the buffer for the result
*
- * @return the number of bytes stored in output
+ * @return the number of bytes stored in {@code output}
*
* @exception IllegalStateException if this exemption mechanism is in
* a wrong state (e.g., has not been initialized).
@@ -450,20 +450,20 @@ public class ExemptionMechanism {
/**
* Generates the exemption mechanism key blob, and stores the result in
- * the output buffer, starting at outputOffset
+ * the {@code output} buffer, starting at {@code outputOffset}
* inclusive.
*
- *
If the {@code output} buffer is too small to hold the result,
+ * a {@code ShortBufferException} is thrown. In this case, repeat this
* call with a larger output buffer. Use
* {@link #getOutputSize(int) getOutputSize} to determine how big
* the output buffer should be.
*
* @param output the buffer for the result
- * @param outputOffset the offset in output where the result
+ * @param outputOffset the offset in {@code output} where the result
* is stored
*
- * @return the number of bytes stored in output
+ * @return the number of bytes stored in {@code output}
*
* @exception IllegalStateException if this exemption mechanism is in
* a wrong state (e.g., has not been initialized).
diff --git a/src/java.base/share/classes/javax/crypto/ExemptionMechanismException.java b/src/java.base/share/classes/javax/crypto/ExemptionMechanismException.java
index 179d6dad454..8b71e437baa 100644
--- a/src/java.base/share/classes/javax/crypto/ExemptionMechanismException.java
+++ b/src/java.base/share/classes/javax/crypto/ExemptionMechanismException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2022, 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,17 +39,17 @@ public class ExemptionMechanismException extends GeneralSecurityException {
private static final long serialVersionUID = 1572699429277957109L;
/**
- * Constructs a ExemptionMechanismException with no detailed message.
- * (A detailed message is a String that describes this particular
- * exception.)
+ * Constructs an {@code ExemptionMechanismException} with no detailed
+ * message. (A detailed message is a {@code String} that describes this
+ * particular exception.)
*/
public ExemptionMechanismException() {
super();
}
/**
- * Constructs a ExemptionMechanismException with the specified
- * detailed message. (A detailed message is a String that describes
+ * Constructs an {@code ExemptionMechanismException} with the specified
+ * detailed message. (A detailed message is a {@code String} that describes
* this particular exception.)
*
* @param msg the detailed message.
diff --git a/src/java.base/share/classes/javax/crypto/ExemptionMechanismSpi.java b/src/java.base/share/classes/javax/crypto/ExemptionMechanismSpi.java
index 2aa59f6c6de..4a2591615c5 100644
--- a/src/java.base/share/classes/javax/crypto/ExemptionMechanismSpi.java
+++ b/src/java.base/share/classes/javax/crypto/ExemptionMechanismSpi.java
@@ -33,7 +33,7 @@ import java.security.spec.AlgorithmParameterSpec;
/**
* This class defines the Service Provider Interface (SPI)
- * for the ExemptionMechanism class.
+ * for the {@code ExemptionMechanism} class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a particular exemption mechanism.
@@ -54,7 +54,7 @@ public abstract class ExemptionMechanismSpi {
* Returns the length in bytes that an output buffer would need to be in
* order to hold the result of the next
* {@link #engineGenExemptionBlob(byte[], int) engineGenExemptionBlob}
- * operation, given the input length inputLen (in bytes).
+ * operation, given the input length {@code inputLen} (in bytes).
*
*
The actual output length of the next
* {@link #engineGenExemptionBlob(byte[], int) engineGenExemptionBlob}
@@ -70,11 +70,11 @@ public abstract class ExemptionMechanismSpi {
* Initializes this exemption mechanism with a key.
*
*
If this exemption mechanism requires any algorithm parameters
- * that cannot be derived from the given key, the underlying
+ * that cannot be derived from the given {@code key}, the underlying
* exemption mechanism implementation is supposed to generate the required
* parameters itself (using provider-specific default values); in the case
* that algorithm parameters must be specified by the caller, an
- * InvalidKeyException is raised.
+ * {@code InvalidKeyException} is raised.
*
* @param key the key for this exemption mechanism
*
@@ -91,11 +91,11 @@ public abstract class ExemptionMechanismSpi {
* parameters.
*
*
If the {@code output} buffer is too small to hold the result,
+ * a {@code ShortBufferException} is thrown. In this case, repeat this
* call with a larger output buffer. Use
* {@link #engineGetOutputSize(int) engineGetOutputSize} to determine
* how big the output buffer should be.
*
* @param output the buffer for the result
- * @param outputOffset the offset in output where the result
+ * @param outputOffset the offset in {@code output} where the result
* is stored
*
- * @return the number of bytes stored in output
+ * @return the number of bytes stored in {@code output}
*
* @exception ShortBufferException if the given output buffer is too small
* to hold the result.
diff --git a/src/java.base/share/classes/javax/crypto/IllegalBlockSizeException.java b/src/java.base/share/classes/javax/crypto/IllegalBlockSizeException.java
index 14f9dd7e30f..1de605b25d5 100644
--- a/src/java.base/share/classes/javax/crypto/IllegalBlockSizeException.java
+++ b/src/java.base/share/classes/javax/crypto/IllegalBlockSizeException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, 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
@@ -41,8 +41,8 @@ public class IllegalBlockSizeException
private static final long serialVersionUID = -1965144811953540392L;
/**
- * Constructs an IllegalBlockSizeException with no detail message.
- * A detail message is a String that describes this particular
+ * Constructs an {@code IllegalBlockSizeException} with no detail message.
+ * A detail message is a {@code String} that describes this particular
* exception.
*/
public IllegalBlockSizeException() {
@@ -50,7 +50,7 @@ public class IllegalBlockSizeException
}
/**
- * Constructs an IllegalBlockSizeException with the specified
+ * Constructs an {@code IllegalBlockSizeException} with the specified
* detail message.
*
* @param msg the detail message.
diff --git a/src/java.base/share/classes/javax/crypto/KeyAgreement.java b/src/java.base/share/classes/javax/crypto/KeyAgreement.java
index 284f538e77b..3f28403b933 100644
--- a/src/java.base/share/classes/javax/crypto/KeyAgreement.java
+++ b/src/java.base/share/classes/javax/crypto/KeyAgreement.java
@@ -105,7 +105,7 @@ public class KeyAgreement {
private final Object lock;
/**
- * Creates a KeyAgreement object.
+ * Creates a {@code KeyAgreement} object.
*
* @param keyAgreeSpi the delegate
* @param provider the provider
@@ -143,11 +143,11 @@ public class KeyAgreement {
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
- *
This method traverses the list of registered security Providers,
- * starting with the most preferred Provider.
- * A new KeyAgreement object encapsulating the
- * KeyAgreementSpi implementation from the first
- * Provider that supports the specified algorithm is returned.
+ *
This method traverses the list of registered security providers,
+ * starting with the most preferred provider.
+ * A new {@code KeyAgreement} object encapsulating the
+ * {@code KeyAgreementSpi} implementation from the first
+ * provider that supports the specified algorithm is returned.
*
*
Note that the list of registered providers may be retrieved via
* the {@link Security#getProviders() Security.getProviders()} method.
@@ -199,8 +199,8 @@ public class KeyAgreement {
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
- *
A new KeyAgreement object encapsulating the
- * KeyAgreementSpi implementation from the specified provider
+ *
A new {@code KeyAgreement} object encapsulating the
+ * {@code KeyAgreementSpi} implementation from the specified provider
* is returned. The specified provider must be registered
* in the security provider list.
*
@@ -246,9 +246,9 @@ public class KeyAgreement {
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
- *
A new KeyAgreement object encapsulating the
- * KeyAgreementSpi implementation from the specified Provider
- * object is returned. Note that the specified Provider object
+ *
A new {@code KeyAgreement} object encapsulating the
+ * {@code KeyAgreementSpi} implementation from the specified
+ * provider is returned. Note that the specified provider
* does not have to be registered in the provider list.
*
* @param algorithm the standard name of the requested key agreement
@@ -267,7 +267,7 @@ public class KeyAgreement {
*
* @throws NoSuchAlgorithmException if a {@code KeyAgreementSpi}
* implementation for the specified algorithm is not available
- * from the specified Provider object
+ * from the specified {@code Provider} object
*
* @throws NullPointerException if {@code algorithm} is {@code null}
*
@@ -437,7 +437,8 @@ public class KeyAgreement {
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness will be used.)
+ * {@code SecureRandom}, a system-provided source of randomness
+ * will be used.)
*
* @param key the party's private information. For example, in the case
* of the Diffie-Hellman key agreement, this would be the party's own
@@ -500,7 +501,8 @@ public class KeyAgreement {
* implementation of the highest-priority
* installed provider as the source of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness will be used.)
+ * {@code SecureRandom}, a system-provided source of randomness
+ * will be used.)
*
* @param key the party's private information. For example, in the case
* of the Diffie-Hellman key agreement, this would be the party's own
@@ -566,7 +568,7 @@ public class KeyAgreement {
* @param lastPhase flag which indicates whether this is the last
* phase of this key agreement.
*
- * @return the (intermediate) key resulting from this phase, or null
+ * @return the (intermediate) key resulting from this phase, or {@code null}
* if this phase does not yield a key
*
* @exception InvalidKeyException if the given key is inappropriate for
diff --git a/src/java.base/share/classes/javax/crypto/KeyAgreementSpi.java b/src/java.base/share/classes/javax/crypto/KeyAgreementSpi.java
index b619f7f617b..a4c242e46cc 100644
--- a/src/java.base/share/classes/javax/crypto/KeyAgreementSpi.java
+++ b/src/java.base/share/classes/javax/crypto/KeyAgreementSpi.java
@@ -30,27 +30,27 @@ import java.security.spec.*;
/**
* This class defines the Service Provider Interface (SPI)
- * for the KeyAgreement class.
+ * for the {@code KeyAgreement} class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a particular key agreement algorithm.
*
*
The keys involved in establishing a shared secret are created by one
* of the
- * key generators (KeyPairGenerator or
- * KeyGenerator), a KeyFactory, or as a result from
+ * key generators ({@code KeyPairGenerator} or
+ * {@code KeyGenerator}), a {@code KeyFactory}, or as a result from
* an intermediate phase of the key agreement protocol
* ({@link #engineDoPhase(java.security.Key, boolean) engineDoPhase}).
*
*
If the key agreement algorithm requires random bytes, it gets them
- * from the given source of randomness, random.
+ * from the given source of randomness, {@code random}.
* However, if the underlying
* algorithm implementation does not require any random bytes,
- * random is ignored.
+ * {@code random} is ignored.
*
* @param key the party's private information. For example, in the case
* of the Diffie-Hellman key agreement, this would be the party's own
@@ -121,8 +121,8 @@ public abstract class KeyAgreementSpi {
* @param lastPhase flag which indicates whether this is the last
* phase of this key agreement.
*
- * @return the (intermediate) key resulting from this phase, or null if
- * this phase does not yield a key
+ * @return the (intermediate) key resulting from this phase,
+ * or {@code null} if this phase does not yield a key
*
* @exception InvalidKeyException if the given key is inappropriate for
* this phase.
@@ -157,10 +157,10 @@ public abstract class KeyAgreementSpi {
/**
* Generates the shared secret, and places it into the buffer
- * sharedSecret, beginning at offset inclusive.
+ * {@code sharedSecret}, beginning at {@code offset} inclusive.
*
- *
If the {@code sharedSecret} buffer is too small to hold the
+ * result, a {@code ShortBufferException} is thrown.
* In this case, this call should be repeated with a larger output buffer.
*
*
This method resets this {@code KeyAgreementSpi} object to the state
@@ -175,10 +175,10 @@ public abstract class KeyAgreementSpi {
* subsequent operations.
*
* @param sharedSecret the buffer for the shared secret
- * @param offset the offset in sharedSecret where the
+ * @param offset the offset in {@code sharedSecret} where the
* shared secret will be stored
*
- * @return the number of bytes placed into sharedSecret
+ * @return the number of bytes placed into {@code sharedSecret}
*
* @exception IllegalStateException if this key agreement has not been
* initialized or if {@code doPhase} has not been called to supply the
diff --git a/src/java.base/share/classes/javax/crypto/KeyGenerator.java b/src/java.base/share/classes/javax/crypto/KeyGenerator.java
index 05614c40092..0b040a42a1a 100644
--- a/src/java.base/share/classes/javax/crypto/KeyGenerator.java
+++ b/src/java.base/share/classes/javax/crypto/KeyGenerator.java
@@ -41,9 +41,9 @@ import sun.security.util.Debug;
*
Key generators are constructed using one of the {@code getInstance}
* class methods of this class.
*
- *
KeyGenerator objects are reusable, i.e., after a key has been
- * generated, the same KeyGenerator object can be re-used to generate further
- * keys.
+ *
{@code KeyGenerator} objects are reusable, i.e., after a key has been
+ * generated, the same {@code KeyGenerator} object can be re-used
+ * to generate further keys.
*
*
There are two ways to generate a key: in an algorithm-independent
* manner, and in an algorithm-specific manner.
@@ -55,9 +55,9 @@ import sun.security.util.Debug;
* source of randomness.
* There is an
* {@link #init(int, java.security.SecureRandom) init}
- * method in this KeyGenerator class that takes these two universally
+ * method in this {@code KeyGenerator} class that takes these two universally
* shared types of arguments. There is also one that takes just a
- * {@code keysize} argument, and uses the SecureRandom implementation
+ * {@code keysize} argument, and uses the {@code SecureRandom} implementation
* of the highest-priority installed provider as the source of randomness
* (or a system-provided source of randomness if none of the installed
* providers supply a SecureRandom implementation), and one that takes just a
@@ -80,17 +80,17 @@ import sun.security.util.Debug;
* providers supply a SecureRandom implementation).
*