org.jlab.coda.cMsg
Class cMsgException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.jlab.coda.cMsg.cMsgException
All Implemented Interfaces:
java.io.Serializable

public class cMsgException
extends java.lang.Exception

This class represents an error that occurred while attempting to execute a cMsg method.

Author:
Carl Timmer
See Also:
Serialized Form

Constructor Summary
cMsgException()
          Constructs a new exception with no message.
cMsgException(java.lang.String msg)
          Constructs a new exception with the specified message.
cMsgException(java.lang.String msg, int returnCode)
          Constructs a new exception with the specified message and a return code.
cMsgException(java.lang.String message, java.lang.Throwable cause)
          Constructs a new exception with the specified detail message and cause.
 
Method Summary
 int getReturnCode()
           
 void setReturnCode(int returnCode)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

cMsgException

public cMsgException(java.lang.String msg,
                     int returnCode)
Constructs a new exception with the specified message and a return code.

Parameters:
msg - the error message
returnCode - send an integer along with the exception

cMsgException

public cMsgException(java.lang.String message,
                     java.lang.Throwable cause)
Constructs a new exception with the specified detail message and cause.

Parameters:
message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
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.)
Since:
1.4

cMsgException

public cMsgException(java.lang.String msg)
Constructs a new exception with the specified message.

Parameters:
msg - the error message

cMsgException

public cMsgException()
Constructs a new exception with no message.

Method Detail

getReturnCode

public int getReturnCode()

setReturnCode

public void setReturnCode(int returnCode)