javax.jms.JMSException Maven / Gradle / Ivy
/*
* @(#)JMSException.java 1.15 02/04/09
*
* Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
*
* SUN PROPRIETARY/CONFIDENTIAL.
* This software is the proprietary information of Sun Microsystems, Inc.
* Use is subject to license terms.
*
*/
package javax.jms;
/**
* This is the root class of all JMS API exceptions.
*
*
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 1.0 - 5 Oct 1998
* @author Mark Hapner
* @author Rich Burridge
**/
public class JMSException extends Exception {
/** Vendor-specific error code.
**/
private String errorCode;
/** Exception reference.
**/
private Exception linkedException;
/** Constructs a 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 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 Exception, null if none
**/
public
Exception getLinkedException() {
return (linkedException);
}
/**
* Adds a linked Exception.
*
* @param ex the linked Exception
**/
public
synchronized void setLinkedException(Exception ex) {
linkedException = ex;
}
}