From d30f173a22d49a586ee59722ac8470efe69558e2 Mon Sep 17 00:00:00 2001 From: Jason Uh Date: Tue, 25 Jun 2013 14:41:46 -0700 Subject: [PATCH] 8017326: Cleanup of the javadoc tag in java.security.spec Convert javadoc and tags to {@code ...} Reviewed-by: darcy --- .../security/spec/DSAGenParameterSpec.java | 20 +++--- .../java/security/spec/DSAParameterSpec.java | 14 ++-- .../java/security/spec/DSAPrivateKeySpec.java | 18 ++--- .../java/security/spec/DSAPublicKeySpec.java | 18 ++--- .../java/security/spec/ECFieldF2m.java | 70 +++++++++---------- .../classes/java/security/spec/ECFieldFp.java | 12 ++-- .../security/spec/ECGenParameterSpec.java | 6 +- .../java/security/spec/ECParameterSpec.java | 12 ++-- .../classes/java/security/spec/ECPoint.java | 14 ++-- .../java/security/spec/ECPrivateKeySpec.java | 6 +- .../java/security/spec/ECPublicKeySpec.java | 8 +-- .../java/security/spec/EllipticCurve.java | 44 ++++++------ .../java/security/spec/EncodedKeySpec.java | 8 +-- .../spec/InvalidKeySpecException.java | 14 ++-- .../classes/java/security/spec/KeySpec.java | 4 +- .../java/security/spec/MGF1ParameterSpec.java | 4 +- .../security/spec/PKCS8EncodedKeySpec.java | 10 +-- .../java/security/spec/PSSParameterSpec.java | 18 ++--- .../security/spec/RSAKeyGenParameterSpec.java | 4 +- .../spec/RSAMultiPrimePrivateCrtKeySpec.java | 18 ++--- .../java/security/spec/RSAOtherPrimeInfo.java | 8 +-- .../security/spec/RSAPrivateCrtKeySpec.java | 4 +- .../security/spec/X509EncodedKeySpec.java | 10 +-- 23 files changed, 172 insertions(+), 172 deletions(-) diff --git a/jdk/src/share/classes/java/security/spec/DSAGenParameterSpec.java b/jdk/src/share/classes/java/security/spec/DSAGenParameterSpec.java index a354c4807ac..932a9f05ccd 100644 --- a/jdk/src/share/classes/java/security/spec/DSAGenParameterSpec.java +++ b/jdk/src/share/classes/java/security/spec/DSAGenParameterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -41,13 +41,13 @@ public final class DSAGenParameterSpec implements AlgorithmParameterSpec { /** * Creates a domain parameter specification for DSA parameter - * generation using primePLen and subprimeQLen. - * The value of subprimeQLen is also used as the default + * generation using {@code primePLen} and {@code subprimeQLen}. + * The value of {@code subprimeQLen} is also used as the default * length of the domain parameter seed in bits. * @param primePLen the desired length of the prime P in bits. * @param subprimeQLen the desired length of the sub-prime Q in bits. - * @exception IllegalArgumentException if primePLen - * or subprimeQLen is illegal per the specification of + * @exception IllegalArgumentException if {@code primePLen} + * or {@code subprimeQLen} is illegal per the specification of * FIPS 186-3. */ public DSAGenParameterSpec(int primePLen, int subprimeQLen) { @@ -56,14 +56,14 @@ public final class DSAGenParameterSpec implements AlgorithmParameterSpec { /** * Creates a domain parameter specification for DSA parameter - * generation using primePLen, subprimeQLen, - * and seedLen. + * generation using {@code primePLen}, {@code subprimeQLen}, + * and {@code seedLen}. * @param primePLen the desired length of the prime P in bits. * @param subprimeQLen the desired length of the sub-prime Q in bits. * @param seedLen the desired length of the domain parameter seed in bits, - * shall be equal to or greater than subprimeQLen. - * @exception IllegalArgumentException if primePLenLen, - * subprimeQLen, or seedLen is illegal per the + * shall be equal to or greater than {@code subprimeQLen}. + * @exception IllegalArgumentException if {@code primePLenLen}, + * {@code subprimeQLen}, or {@code seedLen} is illegal per the * specification of FIPS 186-3. */ public DSAGenParameterSpec(int primePLen, int subprimeQLen, int seedLen) { diff --git a/jdk/src/share/classes/java/security/spec/DSAParameterSpec.java b/jdk/src/share/classes/java/security/spec/DSAParameterSpec.java index 2c9c546669d..eed6bdcae8b 100644 --- a/jdk/src/share/classes/java/security/spec/DSAParameterSpec.java +++ b/jdk/src/share/classes/java/security/spec/DSAParameterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -61,27 +61,27 @@ java.security.interfaces.DSAParams { } /** - * Returns the prime p. + * Returns the prime {@code p}. * - * @return the prime p. + * @return the prime {@code p}. */ public BigInteger getP() { return this.p; } /** - * Returns the sub-prime q. + * Returns the sub-prime {@code q}. * - * @return the sub-prime q. + * @return the sub-prime {@code q}. */ public BigInteger getQ() { return this.q; } /** - * Returns the base g. + * Returns the base {@code g}. * - * @return the base g. + * @return the base {@code g}. */ public BigInteger getG() { return this.g; diff --git a/jdk/src/share/classes/java/security/spec/DSAPrivateKeySpec.java b/jdk/src/share/classes/java/security/spec/DSAPrivateKeySpec.java index 44d6859fd6c..a004de75db3 100644 --- a/jdk/src/share/classes/java/security/spec/DSAPrivateKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/DSAPrivateKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -69,36 +69,36 @@ public class DSAPrivateKeySpec implements KeySpec { } /** - * Returns the private key x. + * Returns the private key {@code x}. * - * @return the private key x. + * @return the private key {@code x}. */ public BigInteger getX() { return this.x; } /** - * Returns the prime p. + * Returns the prime {@code p}. * - * @return the prime p. + * @return the prime {@code p}. */ public BigInteger getP() { return this.p; } /** - * Returns the sub-prime q. + * Returns the sub-prime {@code q}. * - * @return the sub-prime q. + * @return the sub-prime {@code q}. */ public BigInteger getQ() { return this.q; } /** - * Returns the base g. + * Returns the base {@code g}. * - * @return the base g. + * @return the base {@code g}. */ public BigInteger getG() { return this.g; diff --git a/jdk/src/share/classes/java/security/spec/DSAPublicKeySpec.java b/jdk/src/share/classes/java/security/spec/DSAPublicKeySpec.java index 2dfc7384298..a56e6f9c08e 100644 --- a/jdk/src/share/classes/java/security/spec/DSAPublicKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/DSAPublicKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -69,36 +69,36 @@ public class DSAPublicKeySpec implements KeySpec { } /** - * Returns the public key y. + * Returns the public key {@code y}. * - * @return the public key y. + * @return the public key {@code y}. */ public BigInteger getY() { return this.y; } /** - * Returns the prime p. + * Returns the prime {@code p}. * - * @return the prime p. + * @return the prime {@code p}. */ public BigInteger getP() { return this.p; } /** - * Returns the sub-prime q. + * Returns the sub-prime {@code q}. * - * @return the sub-prime q. + * @return the sub-prime {@code q}. */ public BigInteger getQ() { return this.q; } /** - * Returns the base g. + * Returns the base {@code g}. * - * @return the base g. + * @return the base {@code g}. */ public BigInteger getG() { return this.g; diff --git a/jdk/src/share/classes/java/security/spec/ECFieldF2m.java b/jdk/src/share/classes/java/security/spec/ECFieldF2m.java index f271ccbd350..58843ab67da 100644 --- a/jdk/src/share/classes/java/security/spec/ECFieldF2m.java +++ b/jdk/src/share/classes/java/security/spec/ECFieldF2m.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -45,9 +45,9 @@ public class ECFieldF2m implements ECField { /** * Creates an elliptic curve characteristic 2 finite - * field which has 2^m elements with normal basis. - * @param m with 2^m being the number of elements. - * @exception IllegalArgumentException if m + * field which has 2^{@code m} elements with normal basis. + * @param m with 2^{@code m} being the number of elements. + * @exception IllegalArgumentException if {@code m} * is not positive. */ public ECFieldF2m(int m) { @@ -61,24 +61,24 @@ public class ECFieldF2m implements ECField { /** * Creates an elliptic curve characteristic 2 finite - * field which has 2^m elements with + * field which has 2^{@code m} elements with * polynomial basis. * The reduction polynomial for this field is based - * on rp whose i-th bit correspondes to + * on {@code rp} whose i-th bit correspondes to * the i-th coefficient of the reduction polynomial.

* Note: A valid reduction polynomial is either a - * trinomial (X^m + X^k + 1 - * with m > k >= 1) or a - * pentanomial (X^m + X^k3 - * + X^k2 + X^k1 + 1 with - * m > k3 > k2 - * > k1 >= 1). - * @param m with 2^m being the number of elements. + * trinomial (X^{@code m} + X^{@code k} + 1 + * with {@code m} > {@code k} >= 1) or a + * pentanomial (X^{@code m} + X^{@code k3} + * + X^{@code k2} + X^{@code k1} + 1 with + * {@code m} > {@code k3} > {@code k2} + * > {@code k1} >= 1). + * @param m with 2^{@code m} being the number of elements. * @param rp the BigInteger whose i-th bit corresponds to * the i-th coefficient of the reduction polynomial. - * @exception NullPointerException if rp is null. - * @exception IllegalArgumentException if m - * is not positive, or rp does not represent + * @exception NullPointerException if {@code rp} is null. + * @exception IllegalArgumentException if {@code m} + * is not positive, or {@code rp} does not represent * a valid reduction polynomial. */ public ECFieldF2m(int m, BigInteger rp) { @@ -106,28 +106,28 @@ public class ECFieldF2m implements ECField { /** * Creates an elliptic curve characteristic 2 finite - * field which has 2^m elements with + * field which has 2^{@code m} elements with * polynomial basis. The reduction polynomial for this - * field is based on ks whose content + * field is based on {@code ks} whose content * contains the order of the middle term(s) of the * reduction polynomial. * Note: A valid reduction polynomial is either a - * trinomial (X^m + X^k + 1 - * with m > k >= 1) or a - * pentanomial (X^m + X^k3 - * + X^k2 + X^k1 + 1 with - * m > k3 > k2 - * > k1 >= 1), so ks should + * trinomial (X^{@code m} + X^{@code k} + 1 + * with {@code m} > {@code k} >= 1) or a + * pentanomial (X^{@code m} + X^{@code k3} + * + X^{@code k2} + X^{@code k1} + 1 with + * {@code m} > {@code k3} > {@code k2} + * > {@code k1} >= 1), so {@code ks} should * have length 1 or 3. - * @param m with 2^m being the number of elements. + * @param m with 2^{@code m} being the number of elements. * @param ks the order of the middle term(s) of the * reduction polynomial. Contents of this array are copied * to protect against subsequent modification. - * @exception NullPointerException if ks is null. - * @exception IllegalArgumentException ifm - * is not positive, or the length of ks - * is neither 1 nor 3, or values in ks - * are not between m-1 and 1 (inclusive) + * @exception NullPointerException if {@code ks} is null. + * @exception IllegalArgumentException if{@code m} + * is not positive, or the length of {@code ks} + * is neither 1 nor 3, or values in {@code ks} + * are not between {@code m}-1 and 1 (inclusive) * and in descending order. */ public ECFieldF2m(int m, int[] ks) { @@ -160,7 +160,7 @@ public class ECFieldF2m implements ECField { } /** - * Returns the field size in bits which is m + * Returns the field size in bits which is {@code m} * for this characteristic 2 finite field. * @return the field size in bits. */ @@ -169,9 +169,9 @@ public class ECFieldF2m implements ECField { } /** - * Returns the value m of this characteristic + * Returns the value {@code m} of this characteristic * 2 finite field. - * @return m with 2^m being the + * @return {@code m} with 2^{@code m} being the * number of elements. */ public int getM() { @@ -211,8 +211,8 @@ public class ECFieldF2m implements ECField { * Compares this finite field for equality with the * specified object. * @param obj the object to be compared. - * @return true if obj is an instance - * of ECFieldF2m and both m and the reduction + * @return true if {@code obj} is an instance + * of ECFieldF2m and both {@code m} and the reduction * polynomial match, false otherwise. */ public boolean equals(Object obj) { diff --git a/jdk/src/share/classes/java/security/spec/ECFieldFp.java b/jdk/src/share/classes/java/security/spec/ECFieldFp.java index 183549981db..c578962d3c2 100644 --- a/jdk/src/share/classes/java/security/spec/ECFieldFp.java +++ b/jdk/src/share/classes/java/security/spec/ECFieldFp.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -43,10 +43,10 @@ public class ECFieldFp implements ECField { /** * Creates an elliptic curve prime finite field - * with the specified prime p. + * with the specified prime {@code p}. * @param p the prime. - * @exception NullPointerException if p is null. - * @exception IllegalArgumentException if p + * @exception NullPointerException if {@code p} is null. + * @exception IllegalArgumentException if {@code p} * is not positive. */ public ECFieldFp(BigInteger p) { @@ -66,7 +66,7 @@ public class ECFieldFp implements ECField { }; /** - * Returns the prime p of this prime finite field. + * Returns the prime {@code p} of this prime finite field. * @return the prime. */ public BigInteger getP() { @@ -77,7 +77,7 @@ public class ECFieldFp implements ECField { * Compares this prime finite field for equality with the * specified object. * @param obj the object to be compared. - * @return true if obj is an instance + * @return true if {@code obj} is an instance * of ECFieldFp and the prime value match, false otherwise. */ public boolean equals(Object obj) { diff --git a/jdk/src/share/classes/java/security/spec/ECGenParameterSpec.java b/jdk/src/share/classes/java/security/spec/ECGenParameterSpec.java index da1694541b5..4f3f63b873a 100644 --- a/jdk/src/share/classes/java/security/spec/ECGenParameterSpec.java +++ b/jdk/src/share/classes/java/security/spec/ECGenParameterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -41,13 +41,13 @@ public class ECGenParameterSpec implements AlgorithmParameterSpec { /** * Creates a parameter specification for EC parameter * generation using a standard (or predefined) name - * stdName in order to generate the corresponding + * {@code stdName} in order to generate the corresponding * (precomputed) elliptic curve domain parameters. For the * list of supported names, please consult the documentation * of provider whose implementation will be used. * @param stdName the standard name of the to-be-generated EC * domain parameters. - * @exception NullPointerException if stdName + * @exception NullPointerException if {@code stdName} * is null. */ public ECGenParameterSpec(String stdName) { diff --git a/jdk/src/share/classes/java/security/spec/ECParameterSpec.java b/jdk/src/share/classes/java/security/spec/ECParameterSpec.java index 8837516e3bf..3f7cae3b82b 100644 --- a/jdk/src/share/classes/java/security/spec/ECParameterSpec.java +++ b/jdk/src/share/classes/java/security/spec/ECParameterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -49,12 +49,12 @@ public class ECParameterSpec implements AlgorithmParameterSpec { * @param curve the elliptic curve which this parameter * defines. * @param g the generator which is also known as the base point. - * @param n the order of the generator g. + * @param n the order of the generator {@code g}. * @param h the cofactor. - * @exception NullPointerException if curve, - * g, or n is null. - * @exception IllegalArgumentException if n - * or h is not positive. + * @exception NullPointerException if {@code curve}, + * {@code g}, or {@code n} is null. + * @exception IllegalArgumentException if {@code n} + * or {@code h} is not positive. */ public ECParameterSpec(EllipticCurve curve, ECPoint g, BigInteger n, int h) { diff --git a/jdk/src/share/classes/java/security/spec/ECPoint.java b/jdk/src/share/classes/java/security/spec/ECPoint.java index 0c2ce57d96c..1b051c71a13 100644 --- a/jdk/src/share/classes/java/security/spec/ECPoint.java +++ b/jdk/src/share/classes/java/security/spec/ECPoint.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -54,11 +54,11 @@ public class ECPoint { /** * Creates an ECPoint from the specified affine x-coordinate - * x and affine y-coordinate y. + * {@code x} and affine y-coordinate {@code y}. * @param x the affine x-coordinate. * @param y the affine y-coordinate. - * @exception NullPointerException if x or - * y is null. + * @exception NullPointerException if {@code x} or + * {@code y} is null. */ public ECPoint(BigInteger x, BigInteger y) { if ((x==null) || (y==null)) { @@ -69,7 +69,7 @@ public class ECPoint { } /** - * Returns the affine x-coordinate x. + * Returns the affine x-coordinate {@code x}. * Note: POINT_INFINITY has a null affine x-coordinate. * @return the affine x-coordinate. */ @@ -78,7 +78,7 @@ public class ECPoint { } /** - * Returns the affine y-coordinate y. + * Returns the affine y-coordinate {@code y}. * Note: POINT_INFINITY has a null affine y-coordinate. * @return the affine y-coordinate. */ @@ -90,7 +90,7 @@ public class ECPoint { * Compares this elliptic curve point for equality with * the specified object. * @param obj the object to be compared. - * @return true if obj is an instance of + * @return true if {@code obj} is an instance of * ECPoint and the affine coordinates match, false otherwise. */ public boolean equals(Object obj) { diff --git a/jdk/src/share/classes/java/security/spec/ECPrivateKeySpec.java b/jdk/src/share/classes/java/security/spec/ECPrivateKeySpec.java index c8e2c408a86..7f03cfd49e6 100644 --- a/jdk/src/share/classes/java/security/spec/ECPrivateKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/ECPrivateKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -48,8 +48,8 @@ public class ECPrivateKeySpec implements KeySpec { * @param s the private value. * @param params the associated elliptic curve domain * parameters. - * @exception NullPointerException if s - * or params is null. + * @exception NullPointerException if {@code s} + * or {@code params} is null. */ public ECPrivateKeySpec(BigInteger s, ECParameterSpec params) { if (s == null) { diff --git a/jdk/src/share/classes/java/security/spec/ECPublicKeySpec.java b/jdk/src/share/classes/java/security/spec/ECPublicKeySpec.java index 2d8b510ecbd..e0cfb777c50 100644 --- a/jdk/src/share/classes/java/security/spec/ECPublicKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/ECPublicKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -47,9 +47,9 @@ public class ECPublicKeySpec implements KeySpec { * @param w the public point. * @param params the associated elliptic curve domain * parameters. - * @exception NullPointerException if w - * or params is null. - * @exception IllegalArgumentException if w + * @exception NullPointerException if {@code w} + * or {@code params} is null. + * @exception IllegalArgumentException if {@code w} * is point at infinity, i.e. ECPoint.POINT_INFINITY */ public ECPublicKeySpec(ECPoint w, ECParameterSpec params) { diff --git a/jdk/src/share/classes/java/security/spec/EllipticCurve.java b/jdk/src/share/classes/java/security/spec/EllipticCurve.java index d9eef25caf8..8ec97b05ed3 100644 --- a/jdk/src/share/classes/java/security/spec/EllipticCurve.java +++ b/jdk/src/share/classes/java/security/spec/EllipticCurve.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -68,15 +68,15 @@ public class EllipticCurve { /** * Creates an elliptic curve with the specified elliptic field - * field and the coefficients a and - * b. + * {@code field} and the coefficients {@code a} and + * {@code b}. * @param field the finite field that this elliptic curve is over. * @param a the first coefficient of this elliptic curve. * @param b the second coefficient of this elliptic curve. - * @exception NullPointerException if field, - * a, or b is null. - * @exception IllegalArgumentException if a - * or b is not null and not in field. + * @exception NullPointerException if {@code field}, + * {@code a}, or {@code b} is null. + * @exception IllegalArgumentException if {@code a} + * or {@code b} is not null and not in {@code field}. */ public EllipticCurve(ECField field, BigInteger a, BigInteger b) { @@ -85,18 +85,18 @@ public class EllipticCurve { /** * Creates an elliptic curve with the specified elliptic field - * field, the coefficients a and - * b, and the seed used for curve generation. + * {@code field}, the coefficients {@code a} and + * {@code b}, and the {@code seed} used for curve generation. * @param field the finite field that this elliptic curve is over. * @param a the first coefficient of this elliptic curve. * @param b the second coefficient of this elliptic curve. * @param seed the bytes used during curve generation for later * validation. Contents of this array are copied to protect against * subsequent modification. - * @exception NullPointerException if field, - * a, or b is null. - * @exception IllegalArgumentException if a - * or b is not null and not in field. + * @exception NullPointerException if {@code field}, + * {@code a}, or {@code b} is null. + * @exception IllegalArgumentException if {@code a} + * or {@code b} is not null and not in {@code field}. */ public EllipticCurve(ECField field, BigInteger a, BigInteger b, byte[] seed) { @@ -122,9 +122,9 @@ public class EllipticCurve { } /** - * Returns the finite field field that this + * Returns the finite field {@code field} that this * elliptic curve is over. - * @return the field field that this curve + * @return the field {@code field} that this curve * is over. */ public ECField getField() { @@ -132,27 +132,27 @@ public class EllipticCurve { } /** - * Returns the first coefficient a of the + * Returns the first coefficient {@code a} of the * elliptic curve. - * @return the first coefficient a. + * @return the first coefficient {@code a}. */ public BigInteger getA() { return a; } /** - * Returns the second coefficient b of the + * Returns the second coefficient {@code b} of the * elliptic curve. - * @return the second coefficient b. + * @return the second coefficient {@code b}. */ public BigInteger getB() { return b; } /** - * Returns the seeding bytes seed used + * Returns the seeding bytes {@code seed} used * during curve generation. May be null if not specified. - * @return the seeding bytes seed. A new + * @return the seeding bytes {@code seed}. A new * array is returned each time this method is called. */ public byte[] getSeed() { @@ -164,7 +164,7 @@ public class EllipticCurve { * Compares this elliptic curve for equality with the * specified object. * @param obj the object to be compared. - * @return true if obj is an instance of + * @return true if {@code obj} is an instance of * EllipticCurve and the field, A, and B match, false otherwise. */ public boolean equals(Object obj) { diff --git a/jdk/src/share/classes/java/security/spec/EncodedKeySpec.java b/jdk/src/share/classes/java/security/spec/EncodedKeySpec.java index b58781921d2..cc3b81e6ab3 100644 --- a/jdk/src/share/classes/java/security/spec/EncodedKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/EncodedKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -49,7 +49,7 @@ public abstract class EncodedKeySpec implements KeySpec { * * @param encodedKey the encoded key. The contents of the * array are copied to protect against subsequent modification. - * @exception NullPointerException if encodedKey + * @exception NullPointerException if {@code encodedKey} * is null. */ public EncodedKeySpec(byte[] encodedKey) { @@ -74,9 +74,9 @@ public abstract class EncodedKeySpec implements KeySpec { * (see {@link java.security.Key Key}) can be transformed * (see {@link java.security.KeyFactory KeyFactory}) * into this key specification (or a subclass of it), - * getFormat called + * {@code getFormat} called * on the opaque key returns the same value as the - * getFormat method + * {@code getFormat} method * of this key specification. * * @return a string representation of the encoding format. diff --git a/jdk/src/share/classes/java/security/spec/InvalidKeySpecException.java b/jdk/src/share/classes/java/security/spec/InvalidKeySpecException.java index 670913d1366..4655c4abe0c 100644 --- a/jdk/src/share/classes/java/security/spec/InvalidKeySpecException.java +++ b/jdk/src/share/classes/java/security/spec/InvalidKeySpecException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -63,13 +63,13 @@ public class InvalidKeySpecException extends GeneralSecurityException { } /** - * Creates a InvalidKeySpecException with the specified + * Creates a {@code InvalidKeySpecException} with the specified * detail message and cause. * * @param message the detail message (which is saved for later retrieval * by the {@link #getMessage()} method). * @param cause the cause (which is saved for later retrieval by the - * {@link #getCause()} method). (A null value is permitted, + * {@link #getCause()} method). (A {@code null} value is permitted, * and indicates that the cause is nonexistent or unknown.) * @since 1.5 */ @@ -78,13 +78,13 @@ public class InvalidKeySpecException extends GeneralSecurityException { } /** - * Creates a InvalidKeySpecException with the specified cause - * and a detail message of (cause==null ? null : cause.toString()) + * Creates a {@code InvalidKeySpecException} with the specified cause + * and a detail message of {@code (cause==null ? null : cause.toString())} * (which typically contains the class and detail message of - * cause). + * {@code cause}). * * @param cause the cause (which is saved for later retrieval by the - * {@link #getCause()} method). (A null value is permitted, + * {@link #getCause()} method). (A {@code null} value is permitted, * and indicates that the cause is nonexistent or unknown.) * @since 1.5 */ diff --git a/jdk/src/share/classes/java/security/spec/KeySpec.java b/jdk/src/share/classes/java/security/spec/KeySpec.java index 26c9777ef07..34fec5d3125 100644 --- a/jdk/src/share/classes/java/security/spec/KeySpec.java +++ b/jdk/src/share/classes/java/security/spec/KeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -36,7 +36,7 @@ package java.security.spec; *

A key may be specified in an algorithm-specific way, or in an * algorithm-independent encoding format (such as ASN.1). * For example, a DSA private key may be specified by its components - * x, p, q, and g + * {@code x}, {@code p}, {@code q}, and {@code g} * (see {@link DSAPrivateKeySpec}), or it may be * specified using its DER encoding * (see {@link PKCS8EncodedKeySpec}). diff --git a/jdk/src/share/classes/java/security/spec/MGF1ParameterSpec.java b/jdk/src/share/classes/java/security/spec/MGF1ParameterSpec.java index c1f1de37130..1be267f0ced 100644 --- a/jdk/src/share/classes/java/security/spec/MGF1ParameterSpec.java +++ b/jdk/src/share/classes/java/security/spec/MGF1ParameterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -92,7 +92,7 @@ public class MGF1ParameterSpec implements AlgorithmParameterSpec { * * @param mdName the algorithm name for the message digest * used in this mask generation function MGF1. - * @exception NullPointerException if mdName is null. + * @exception NullPointerException if {@code mdName} is null. */ public MGF1ParameterSpec(String mdName) { if (mdName == null) { diff --git a/jdk/src/share/classes/java/security/spec/PKCS8EncodedKeySpec.java b/jdk/src/share/classes/java/security/spec/PKCS8EncodedKeySpec.java index b6dabad364b..060f266fcb1 100644 --- a/jdk/src/share/classes/java/security/spec/PKCS8EncodedKeySpec.java +++ b/jdk/src/share/classes/java/security/spec/PKCS8EncodedKeySpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -27,8 +27,8 @@ package java.security.spec; /** * This class represents the ASN.1 encoding of a private key, - * encoded according to the ASN.1 type PrivateKeyInfo. - * The PrivateKeyInfo syntax is defined in the PKCS#8 standard + * encoded according to the ASN.1 type {@code PrivateKeyInfo}. + * The {@code PrivateKeyInfo} syntax is defined in the PKCS#8 standard * as follows: * * 

@@ -67,7 +67,7 @@ public class PKCS8EncodedKeySpec extends EncodedKeySpec {
      * @param encodedKey the key, which is assumed to be
      * encoded according to the PKCS #8 standard. The contents of
      * the array are copied to protect against subsequent modification.
-     * @exception NullPointerException if encodedKey
+     * @exception NullPointerException if {@code encodedKey}
      * is null.
      */
     public PKCS8EncodedKeySpec(byte[] encodedKey) {
@@ -88,7 +88,7 @@ public class PKCS8EncodedKeySpec extends EncodedKeySpec {
      * Returns the name of the encoding format associated with this
      * key specification.
      *
-     * @return the string "PKCS#8".
+     * @return the string {@code "PKCS#8"}.
      */
     public final String getFormat() {
         return "PKCS#8";
diff --git a/jdk/src/share/classes/java/security/spec/PSSParameterSpec.java b/jdk/src/share/classes/java/security/spec/PSSParameterSpec.java
index 37a2eeb2625..a9b82d8e42b 100644
--- a/jdk/src/share/classes/java/security/spec/PSSParameterSpec.java
+++ b/jdk/src/share/classes/java/security/spec/PSSParameterSpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -91,14 +91,14 @@ public class PSSParameterSpec implements AlgorithmParameterSpec {
     public static final PSSParameterSpec DEFAULT = new PSSParameterSpec();
 
     /**
-     * Constructs a new PSSParameterSpec as defined in
+     * Constructs a new {@code PSSParameterSpec} as defined in
      * the PKCS #1 standard using the default values.
      */
     private PSSParameterSpec() {
     }
 
     /**
-     * Creates a new PSSParameterSpec as defined in
+     * Creates a new {@code PSSParameterSpec} as defined in
      * the PKCS #1 standard using the specified message digest,
      * mask generation function, parameters for mask generation
      * function, salt length, and trailer field values.
@@ -111,10 +111,10 @@ public class PSSParameterSpec implements AlgorithmParameterSpec {
      * getMGFParameters().
      * @param saltLen the length of salt.
      * @param trailerField the value of the trailer field.
-     * @exception NullPointerException if mdName,
-     * or mgfName is null.
-     * @exception IllegalArgumentException if saltLen
-     * or trailerField is less than 0.
+     * @exception NullPointerException if {@code mdName},
+     * or {@code mgfName} is null.
+     * @exception IllegalArgumentException if {@code saltLen}
+     * or {@code trailerField} is less than 0.
      * @since 1.5
      */
     public PSSParameterSpec(String mdName, String mgfName,
@@ -143,13 +143,13 @@ public class PSSParameterSpec implements AlgorithmParameterSpec {
     }
 
     /**
-     * Creates a new PSSParameterSpec
+     * Creates a new {@code PSSParameterSpec}
      * using the specified salt length and other default values as
      * defined in PKCS#1.
      *
      * @param saltLen the length of salt in bits to be used in PKCS#1
      * PSS encoding.
-     * @exception IllegalArgumentException if saltLen is
+     * @exception IllegalArgumentException if {@code saltLen} is
      * less than 0.
      */
     public PSSParameterSpec(int saltLen) {
diff --git a/jdk/src/share/classes/java/security/spec/RSAKeyGenParameterSpec.java b/jdk/src/share/classes/java/security/spec/RSAKeyGenParameterSpec.java
index e9a10fa58a8..a73c6cd46b7 100644
--- a/jdk/src/share/classes/java/security/spec/RSAKeyGenParameterSpec.java
+++ b/jdk/src/share/classes/java/security/spec/RSAKeyGenParameterSpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -55,7 +55,7 @@ public class RSAKeyGenParameterSpec implements AlgorithmParameterSpec {
     public static final BigInteger F4 = BigInteger.valueOf(65537);
 
     /**
-     * Constructs a new RSAParameterSpec object from the
+     * Constructs a new {@code RSAParameterSpec} object from the
      * given keysize and public-exponent value.
      *
      * @param keysize the modulus size (specified in number of bits)
diff --git a/jdk/src/share/classes/java/security/spec/RSAMultiPrimePrivateCrtKeySpec.java b/jdk/src/share/classes/java/security/spec/RSAMultiPrimePrivateCrtKeySpec.java
index 97346d6e22a..a198e43a2e1 100644
--- a/jdk/src/share/classes/java/security/spec/RSAMultiPrimePrivateCrtKeySpec.java
+++ b/jdk/src/share/classes/java/security/spec/RSAMultiPrimePrivateCrtKeySpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -57,12 +57,12 @@ public class RSAMultiPrimePrivateCrtKeySpec extends RSAPrivateKeySpec {
     private final RSAOtherPrimeInfo otherPrimeInfo[];
 
    /**
-    * Creates a new RSAMultiPrimePrivateCrtKeySpec
+    * Creates a new {@code RSAMultiPrimePrivateCrtKeySpec}
     * given the modulus, publicExponent, privateExponent,
     * primeP, primeQ, primeExponentP, primeExponentQ,
     * crtCoefficient, and otherPrimeInfo as defined in PKCS#1 v2.1.
     *
-    * 
Note that the contents of otherPrimeInfo
+    * 
Note that the contents of {@code otherPrimeInfo}
     * are copied to protect against subsequent modification when
     * constructing this object.
     *
@@ -78,13 +78,13 @@ public class RSAMultiPrimePrivateCrtKeySpec extends RSAPrivateKeySpec {
     * @param otherPrimeInfo triplets of the rest of primes, null can be
     * specified if there are only two prime factors (p and q).
     * @exception NullPointerException if any of the parameters, i.e.
-    * modulus,
-    * publicExponent, privateExponent,
-    * primeP, primeQ,
-    * primeExponentP, primeExponentQ,
-    * crtCoefficient, is null.
+    * {@code modulus},
+    * {@code publicExponent}, {@code privateExponent},
+    * {@code primeP}, {@code primeQ},
+    * {@code primeExponentP}, {@code primeExponentQ},
+    * {@code crtCoefficient}, is null.
     * @exception IllegalArgumentException if an empty, i.e. 0-length,
-    * otherPrimeInfo is specified.
+    * {@code otherPrimeInfo} is specified.
     */
     public RSAMultiPrimePrivateCrtKeySpec(BigInteger modulus,
                                 BigInteger publicExponent,
diff --git a/jdk/src/share/classes/java/security/spec/RSAOtherPrimeInfo.java b/jdk/src/share/classes/java/security/spec/RSAOtherPrimeInfo.java
index e0889152dcd..10d8471765d 100644
--- a/jdk/src/share/classes/java/security/spec/RSAOtherPrimeInfo.java
+++ b/jdk/src/share/classes/java/security/spec/RSAOtherPrimeInfo.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -58,7 +58,7 @@ public class RSAOtherPrimeInfo {
 
 
    /**
-    * Creates a new RSAOtherPrimeInfo
+    * Creates a new {@code RSAOtherPrimeInfo}
     * given the prime, primeExponent, and
     * crtCoefficient as defined in PKCS#1.
     *
@@ -67,8 +67,8 @@ public class RSAOtherPrimeInfo {
     * @param crtCoefficient the Chinese Remainder Theorem
     * coefficient.
     * @exception NullPointerException if any of the parameters, i.e.
-    * prime, primeExponent,
-    * crtCoefficient, is null.
+    * {@code prime}, {@code primeExponent},
+    * {@code crtCoefficient}, is null.
     *
     */
     public RSAOtherPrimeInfo(BigInteger prime,
diff --git a/jdk/src/share/classes/java/security/spec/RSAPrivateCrtKeySpec.java b/jdk/src/share/classes/java/security/spec/RSAPrivateCrtKeySpec.java
index c8d8faa5e53..d0ba70be443 100644
--- a/jdk/src/share/classes/java/security/spec/RSAPrivateCrtKeySpec.java
+++ b/jdk/src/share/classes/java/security/spec/RSAPrivateCrtKeySpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -55,7 +55,7 @@ public class RSAPrivateCrtKeySpec extends RSAPrivateKeySpec {
 
 
    /**
-    * Creates a new RSAPrivateCrtKeySpec
+    * Creates a new {@code RSAPrivateCrtKeySpec}
     * given the modulus, publicExponent, privateExponent,
     * primeP, primeQ, primeExponentP, primeExponentQ, and
     * crtCoefficient as defined in PKCS#1.
diff --git a/jdk/src/share/classes/java/security/spec/X509EncodedKeySpec.java b/jdk/src/share/classes/java/security/spec/X509EncodedKeySpec.java
index 7dd3d7bf244..b9984de87e3 100644
--- a/jdk/src/share/classes/java/security/spec/X509EncodedKeySpec.java
+++ b/jdk/src/share/classes/java/security/spec/X509EncodedKeySpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -27,8 +27,8 @@ package java.security.spec;
 
 /**
  * This class represents the ASN.1 encoding of a public key,
- * encoded according to the ASN.1 type SubjectPublicKeyInfo.
- * The SubjectPublicKeyInfo syntax is defined in the X.509
+ * encoded according to the ASN.1 type {@code SubjectPublicKeyInfo}.
+ * The {@code SubjectPublicKeyInfo} syntax is defined in the X.509
  * standard as follows:
  *
  * 
@@ -57,7 +57,7 @@ public class X509EncodedKeySpec extends EncodedKeySpec {
      * @param encodedKey the key, which is assumed to be
      * encoded according to the X.509 standard. The contents of the
      * array are copied to protect against subsequent modification.
-     * @exception NullPointerException if encodedKey
+     * @exception NullPointerException if {@code encodedKey}
      * is null.
      */
     public X509EncodedKeySpec(byte[] encodedKey) {
@@ -78,7 +78,7 @@ public class X509EncodedKeySpec extends EncodedKeySpec {
      * Returns the name of the encoding format associated with this
      * key specification.
      *
-     * @return the string "X.509".
+     * @return the string {@code "X.509"}.
      */
     public final String getFormat() {
         return "X.509";