jdk/src/share/classes/java/security/cert/CertPathValidatorException.java
changeset 18551 882a3948c6e6
parent 18156 edb590d448c5
--- a/jdk/src/share/classes/java/security/cert/CertPathValidatorException.java	Tue Jun 25 20:06:09 2013 +0100
+++ b/jdk/src/share/classes/java/security/cert/CertPathValidatorException.java	Tue Jun 25 14:31:29 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 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
@@ -34,11 +34,11 @@
  * An exception indicating one of a variety of problems encountered when
  * validating a certification path.
  * <p>
- * A <code>CertPathValidatorException</code> provides support for wrapping
+ * A {@code CertPathValidatorException} provides support for wrapping
  * exceptions. The {@link #getCause getCause} method returns the throwable,
  * if any, that caused this exception to be thrown.
  * <p>
- * A <code>CertPathValidatorException</code> may also include the
+ * A {@code CertPathValidatorException} may also include the
  * certification path that was being validated when the exception was thrown,
  * the index of the certificate in the certification path that caused the
  * exception to be thrown, and the reason that caused the failure. Use the
@@ -70,7 +70,7 @@
     private int index = -1;
 
     /**
-     * @serial the <code>CertPath</code> that was being validated when
+     * @serial the {@code CertPath} that was being validated when
      * the exception was thrown
      */
     private CertPath certPath;
@@ -81,7 +81,7 @@
     private Reason reason = BasicReason.UNSPECIFIED;
 
     /**
-     * Creates a <code>CertPathValidatorException</code> with
+     * Creates a {@code CertPathValidatorException} with
      * no detail message.
      */
     public CertPathValidatorException() {
@@ -89,8 +89,8 @@
     }
 
     /**
-     * Creates a <code>CertPathValidatorException</code> with the given
-     * detail message. A detail message is a <code>String</code> that
+     * Creates a {@code CertPathValidatorException} with the given
+     * detail message. A detail message is a {@code String} that
      * describes this particular exception.
      *
      * @param msg the detail message
@@ -100,16 +100,16 @@
     }
 
     /**
-     * Creates a <code>CertPathValidatorException</code> that wraps the
+     * Creates a {@code CertPathValidatorException} that wraps the
      * specified throwable. This allows any exception to be converted into a
-     * <code>CertPathValidatorException</code>, while retaining information
+     * {@code CertPathValidatorException}, while retaining information
      * about the wrapped exception, which may be useful for debugging. The
-     * detail message is set to (<code>cause==null ? null : cause.toString()
-     * </code>) (which typically contains the class and detail message of
+     * detail message is set to ({@code cause==null ? null : cause.toString()})
+     * (which typically contains the class and detail message of
      * cause).
      *
      * @param cause the cause (which is saved for later retrieval by the
-     * {@link #getCause getCause()} method). (A <code>null</code> value is
+     * {@link #getCause getCause()} method). (A {@code null} value is
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public CertPathValidatorException(Throwable cause) {
@@ -117,12 +117,12 @@
     }
 
     /**
-     * Creates a <code>CertPathValidatorException</code> with the specified
+     * Creates a {@code CertPathValidatorException} with the specified
      * detail message and cause.
      *
      * @param msg the detail message
      * @param cause the cause (which is saved for later retrieval by the
-     * {@link #getCause getCause()} method). (A <code>null</code> value is
+     * {@link #getCause getCause()} method). (A {@code null} value is
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public CertPathValidatorException(String msg, Throwable cause) {
@@ -130,21 +130,21 @@
     }
 
     /**
-     * Creates a <code>CertPathValidatorException</code> with the specified
+     * Creates a {@code CertPathValidatorException} with the specified
      * detail message, cause, certification path, and index.
      *
-     * @param msg the detail message (or <code>null</code> if none)
-     * @param cause the cause (or <code>null</code> if none)
+     * @param msg the detail message (or {@code null} if none)
+     * @param cause the cause (or {@code null} if none)
      * @param certPath the certification path that was in the process of
      * being validated when the error was encountered
      * @param index the index of the certificate in the certification path
      * that caused the error (or -1 if not applicable). Note that
-     * the list of certificates in a <code>CertPath</code> is zero based.
+     * the list of certificates in a {@code CertPath} is zero based.
      * @throws IndexOutOfBoundsException if the index is out of range
      * {@code (index < -1 || (certPath != null && index >=
      * certPath.getCertificates().size()) }
-     * @throws IllegalArgumentException if <code>certPath</code> is
-     * <code>null</code> and <code>index</code> is not -1
+     * @throws IllegalArgumentException if {@code certPath} is
+     * {@code null} and {@code index} is not -1
      */
     public CertPathValidatorException(String msg, Throwable cause,
             CertPath certPath, int index) {
@@ -152,23 +152,23 @@
     }
 
     /**
-     * Creates a <code>CertPathValidatorException</code> with the specified
+     * Creates a {@code CertPathValidatorException} with the specified
      * detail message, cause, certification path, index, and reason.
      *
-     * @param msg the detail message (or <code>null</code> if none)
-     * @param cause the cause (or <code>null</code> if none)
+     * @param msg the detail message (or {@code null} if none)
+     * @param cause the cause (or {@code null} if none)
      * @param certPath the certification path that was in the process of
      * being validated when the error was encountered
      * @param index the index of the certificate in the certification path
      * that caused the error (or -1 if not applicable). Note that
-     * the list of certificates in a <code>CertPath</code> is zero based.
+     * the list of certificates in a {@code CertPath} is zero based.
      * @param reason the reason the validation failed
      * @throws IndexOutOfBoundsException if the index is out of range
      * {@code (index < -1 || (certPath != null && index >=
      * certPath.getCertificates().size()) }
-     * @throws IllegalArgumentException if <code>certPath</code> is
-     * <code>null</code> and <code>index</code> is not -1
-     * @throws NullPointerException if <code>reason</code> is <code>null</code>
+     * @throws IllegalArgumentException if {@code certPath} is
+     * {@code null} and {@code index} is not -1
+     * @throws NullPointerException if {@code reason} is {@code null}
      *
      * @since 1.7
      */
@@ -194,8 +194,8 @@
      * Returns the certification path that was being validated when
      * the exception was thrown.
      *
-     * @return the <code>CertPath</code> that was being validated when
-     * the exception was thrown (or <code>null</code> if not specified)
+     * @return the {@code CertPath} that was being validated when
+     * the exception was thrown (or {@code null} if not specified)
      */
     public CertPath getCertPath() {
         return this.certPath;
@@ -204,7 +204,7 @@
     /**
      * Returns the index of the certificate in the certification path
      * that caused the exception to be thrown. Note that the list of
-     * certificates in a <code>CertPath</code> is zero based. If no
+     * certificates in a {@code CertPath} is zero based. If no
      * index has been set, -1 is returned.
      *
      * @return the index that has been set, or -1 if none has been set
@@ -219,7 +219,7 @@
      * {@link #getIndex}.
      *
      * @return the reason that the validation failed, or
-     *    <code>BasicReason.UNSPECIFIED</code> if a reason has not been
+     *    {@code BasicReason.UNSPECIFIED} if a reason has not been
      *    specified
      *
      * @since 1.7