org.jlab.coda.cMsg

Class cMsgException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

Constructors

Constructor and Description
cMsgException() Constructs a new exception with null as its detail message.
cMsgException(java.lang.String message) Constructs a new exception with the specified detail message.
cMsgException(java.lang.String message, int returnCode) Constructs a new exception with the specified detail 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.
cMsgException(java.lang.Throwable cause) Constructs a new exception 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

Modifier and Type	Method and Description
int	getReturnCode() Get the return code specified in the constructor cMsgException(String, int).
void	setReturnCode(int returnCode) Set the return code.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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 message,
                     int returnCode)

Constructs a new exception with the specified detail message and a return code. 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 Throwable.getMessage() method.

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.

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 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.Throwable cause)

Constructs a new exception 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.

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.)

Since:

1.4

cMsgException

public cMsgException(java.lang.String message)

Constructs a new exception 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 Throwable.getMessage() method.

cMsgException

public cMsgException()

Constructs a new exception 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).

Method Detail

getReturnCode

public int getReturnCode()

Get the return code specified in the constructor cMsgException(String, int).

Returns:

the return code

setReturnCode

public void setReturnCode(int returnCode)

Set the return code.

Parameters:

returnCode - return code