< prev index next >

src/java.xml.ws/share/classes/javax/xml/soap/SOAPException.java

Print this page

        

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2004, 2015, 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
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -25,84 +25,84 @@
 
 package javax.xml.soap;
 
 /**
  * An exception that signals that a SOAP exception has occurred. A
- * <code>SOAPException</code> object may contain a <code>String</code>
+ * {@code SOAPException} object may contain a {@code String}
  * that gives the reason for the exception, an embedded
- * <code>Throwable</code> object, or both. This class provides methods
+ * {@code Throwable} object, or both. This class provides methods
  * for retrieving reason messages and for retrieving the embedded
- * <code>Throwable</code> object.
+ * {@code Throwable} object.
  *
- * <P> Typical reasons for throwing a <code>SOAPException</code>
+ * <P> Typical reasons for throwing a {@code SOAPException}
  * object are problems such as difficulty setting a header, not being
  * able to send a message, and not being able to get a connection with
- * the provider.  Reasons for embedding a <code>Throwable</code>
+ * the provider.  Reasons for embedding a {@code Throwable}
  * object include problems such as input/output errors or a parsing
  * problem, such as an error in parsing a header.
  *
  * @since 1.6
  */
 public class SOAPException extends Exception {
     private Throwable cause;
 
     /**
-     * Constructs a <code>SOAPException</code> object with no
-     * reason or embedded <code>Throwable</code> object.
+     * Constructs a {@code SOAPException} object with no
+     * reason or embedded {@code Throwable} object.
      */
     public SOAPException() {
         super();
         this.cause = null;
     }
 
     /**
-     * Constructs a <code>SOAPException</code> object with the given
-     * <code>String</code> as the reason for the exception being thrown.
+     * Constructs a {@code SOAPException} object with the given
+     * {@code String} as the reason for the exception being thrown.
      *
      * @param reason a description of what caused the exception
      */
     public SOAPException(String reason) {
         super(reason);
         this.cause = null;
     }
 
     /**
-     * Constructs a <code>SOAPException</code> object with the given
-     * <code>String</code> as the reason for the exception being thrown
-     * and the given <code>Throwable</code> object as an embedded
+     * Constructs a {@code SOAPException} object with the given
+     * {@code String} as the reason for the exception being thrown
+     * and the given {@code Throwable} object as an embedded
      * exception.
      *
      * @param reason a description of what caused the exception
-     * @param cause a <code>Throwable</code> object that is to
-     *        be embedded in this <code>SOAPException</code> object
+     * @param cause a {@code Throwable} object that is to
+     *        be embedded in this {@code SOAPException} object
      */
     public SOAPException(String reason, Throwable cause) {
         super(reason);
         initCause(cause);
     }
 
     /**
-     * Constructs a <code>SOAPException</code> object initialized
-     * with the given <code>Throwable</code> object.
+     * Constructs a {@code SOAPException} object initialized
+     * with the given {@code Throwable} object.
      */
     public SOAPException(Throwable cause) {
         super(cause.toString());
         initCause(cause);
     }
 
     /**
-     * Returns the detail message for this <code>SOAPException</code>
+     * Returns the detail message for this {@code SOAPException}
      * object.
      * <P>
-     * If there is an embedded <code>Throwable</code> object, and if the
-     * <code>SOAPException</code> object has no detail message of its
+     * If there is an embedded {@code Throwable} object, and if the
+     * {@code SOAPException} object has no detail message of its
      * own, this method will return the detail message from the embedded
-     * <code>Throwable</code> object.
+     * {@code Throwable} object.
      *
      * @return the error or warning message for this
-     *         <code>SOAPException</code> or, if it has none, the
-     *         message of the embedded <code>Throwable</code> object,
+     *         {@code SOAPException} or, if it has none, the
+     *         message of the embedded {@code Throwable} object,
      *         if there is one
      */
     public String getMessage() {
         String message = super.getMessage();
         if (message == null && cause != null) {

@@ -111,46 +111,46 @@
             return message;
         }
     }
 
     /**
-     * Returns the <code>Throwable</code> object embedded in this
-     * <code>SOAPException</code> if there is one. Otherwise, this method
-     * returns <code>null</code>.
+     * Returns the {@code Throwable} object embedded in this
+     * {@code SOAPException} if there is one. Otherwise, this method
+     * returns {@code null}.
      *
-     * @return the embedded <code>Throwable</code> object or <code>null</code>
+     * @return the embedded {@code Throwable} object or {@code null}
      *         if there is none
      */
 
     public Throwable getCause() {
         return cause;
     }
 
     /**
-     * Initializes the <code>cause</code> field of this <code>SOAPException</code>
-     * object with the given <code>Throwable</code> object.
+     * Initializes the {@code cause} field of this {@code SOAPException}
+     * object with the given {@code Throwable} object.
      * <P>
      * This method can be called at most once.  It is generally called from
      * within the constructor or immediately after the constructor has
-     * returned a new <code>SOAPException</code> object.
-     * If this <code>SOAPException</code> object was created with the
+     * returned a new {@code SOAPException} object.
+     * If this {@code SOAPException} object was created with the
      * constructor {@link #SOAPException(Throwable)} or
      * {@link #SOAPException(String,Throwable)}, meaning that its
-     * <code>cause</code> field already has a value, this method cannot be
+     * {@code cause} field already has a value, this method cannot be
      * called even once.
      *
-     * @param  cause the <code>Throwable</code> object that caused this
-     *         <code>SOAPException</code> object to be thrown.  The value of this
+     * @param  cause the {@code Throwable} object that caused this
+     *         {@code SOAPException} object to be thrown.  The value of this
      *         parameter is saved for later retrieval by the
      *         {@link #getCause()} method.  A <tt>null</tt> value is
      *         permitted and indicates that the cause is nonexistent or
      *         unknown.
-     * @return  a reference to this <code>SOAPException</code> instance
-     * @throws IllegalArgumentException if <code>cause</code> is this
-     *         <code>Throwable</code> object.  (A <code>Throwable</code> object
+     * @return  a reference to this {@code SOAPException} instance
+     * @throws IllegalArgumentException if {@code cause} is this
+     *         {@code Throwable} object.  (A {@code Throwable} object
      *         cannot be its own cause.)
-     * @throws IllegalStateException if the cause for this <code>SOAPException</code> object
+     * @throws IllegalStateException if the cause for this {@code SOAPException} object
      *         has already been initialized
      */
     public synchronized Throwable initCause(Throwable cause) {
         if (this.cause != null) {
             throw new IllegalStateException("Can't override cause");
< prev index next >