javax.jms.JMSException.java Source code

Introduction

Here is the source code for javax.jms.JMSException.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2014 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.jms;

/**
 * <P>This is the root class of all checked exceptions in the JMS API.
 *
 * <P>It provides the following information:
 * <UL>
 *   <LI> A provider-specific string describing the error. This string is 
 *        the standard exception message and is available via the
 *        {@code getMessage} method.
 *   <LI> A provider-specific string error code 
 *   <LI> A reference to another exception. Often a JMS API exception will 
 *        be the result of a lower-level problem. If appropriate, this 
 *        lower-level exception can be linked to the JMS API exception.
 * </UL>
 * 
 * @version JMS 2.0
 * @since JMS 1.0
 * 
 **/

public class JMSException extends Exception {

    /**
     * Explicitly set serialVersionUID to be the same as the implicit serialVersionUID of the JMS 1.1 version
     */
    private static final long serialVersionUID = 8951994251593378324L;

    /** Vendor-specific error code.
    **/
    private String errorCode;

    /** {@code Exception} reference.
    **/
    private Exception linkedException;

    /** Constructs a {@code JMSException} with the specified reason and 
     *  error code.
     *
     *  @param  reason        a description of the exception
     *  @param  errorCode     a string specifying the vendor-specific
     *                        error code
     **/
    public JMSException(String reason, String errorCode) {
        super(reason);
        this.errorCode = errorCode;
        linkedException = null;
    }

    /** Constructs a {@code JMSException} with the specified reason and with
     *  the error code defaulting to null.
     *
     *  @param  reason        a description of the exception
     **/
    public JMSException(String reason) {
        super(reason);
        this.errorCode = null;
        linkedException = null;
    }

    /** Gets the vendor-specific error code.
     *  @return   a string specifying the vendor-specific
     *                        error code
    **/
    public String getErrorCode() {
        return this.errorCode;
    }

    /**
     * Gets the exception linked to this one.
     *
     * @return the linked {@code Exception}, null if none
    **/
    public Exception getLinkedException() {
        return (linkedException);
    }

    /**
     * Adds a linked {@code Exception}.
     *
     * @param ex       the linked {@code Exception}
    **/
    public void setLinkedException(Exception ex) {
        linkedException = ex;
    }
}