8284851: Update javax.crypto files to use proper javadoc for mentioned classes

Reviewed-by: weijun, valeriep
This commit is contained in:
Mark Powers 2022-07-07 23:20:58 +00:00 committed by Valerie Peng
parent 8cdead0c94
commit f804f2ce8e
92 changed files with 2142 additions and 2010 deletions

View file

@ -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();