javax.jms.JMSRuntimeException Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011-2012 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;

/**
 * This is the root class of all unchecked exceptions in the JMS API  
 *
 * 
It provides the following information:
 * 

 *    A provider-specific string describing the error. This string is 
 *        the standard exception message and is available via the
 *        getMessage method.
 *   
 A provider-specific string error code 
 *   
 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.
 * 
 * @version     2.0
 **/

public class JMSRuntimeException extends RuntimeException {

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

	  /** Exception reference.
	  **/
	  private Exception linkedException;


	  /** Constructs a JMSRuntimeException 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 
	  JMSRuntimeException(String reason, String errorCode) {
	    super(reason);
	    this.errorCode = errorCode;
	    linkedException = null;
	  }

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

	/** 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 Exception, null if none
	  **/
	  public 
	  Exception getLinkedException() {
	    return (linkedException);
	  }

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