com.ibm.carma
Class CARMAException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.carma.CARMAException
All Implemented Interfaces:
java.io.Serializable

public class CARMAException
extends java.lang.Exception

Generic exception thrown by the CARMA system

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
CARMAException()
          Constructs a new CARMAException with null as its detail message.
CARMAException(java.lang.String message, int error)
          Constructs a new CARMAException with the specified detail message.
CARMAException(java.lang.String message, int error, java.lang.Throwable cause)
          Constructs a new CARMAException with the specified detail message and cause.
CARMAException(java.lang.Throwable cause)
          Constructs a new CARMAException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
 
Method Summary
 int getErrorCode()
          Obtain the CARMA system error code associated with the exception
 java.lang.String getMessage()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

CARMAException

public CARMAException()
Constructs a new CARMAException with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).


CARMAException

public CARMAException(java.lang.String message,
                      int error)
Constructs a new CARMAException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:
message - the detail message. The detail message is saved for later retrieval by the getMessage() method.
error - Error code associated with the exception

CARMAException

public CARMAException(java.lang.String message,
                      int error,
                      java.lang.Throwable cause)
Constructs a new CARMAException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:
message - the detail message (which is saved for later retrieval by the getMessage() method).
error - Error code associated with the exception
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CARMAException

public CARMAException(java.lang.Throwable cause)
Constructs a new CARMAException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables (for example, java.security.PrivilegedActionException).

Parameters:
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
Method Detail

getErrorCode

public int getErrorCode()
Obtain the CARMA system error code associated with the exception

Returns:
error code associated with the exception

getMessage

public java.lang.String getMessage()
Overrides:
getMessage in class java.lang.Throwable