public class Theater_Protocol_Exception extends IOException
A Theater_Protocol_Exception may have a message, reason and cause. Usually the message is provided by the caller to descrbe the context of the exception and/or provide information that may be useful is solving the problem. A reason code is intended to indicate the category of the problem.
Theater
,
Serialized FormModifier and Type | Field and Description |
---|---|
static String |
ID |
static int |
INVALID_MESSAGE
The
reason code indicating that a protocol Message
contained invalid content. |
static int |
TIMEOUT
The
reason code indicating that the operation did
not complete within the allowed timeout period. |
static int |
UNAUTHENTICATED
The
reason code indicating that the identity
authentication during the initial handshake with the Stage_Manager
was not successful. |
static int |
UNSPECIFIED
The default
reason code indicating that categorization
of the exception was not specified. |
Constructor and Description |
---|
Theater_Protocol_Exception()
Construct an empty Theater_Protocol_Exception.
|
Theater_Protocol_Exception(int reason,
Throwable cause)
Construct a Theater_Protocol_Exception with a reason and cause.
|
Theater_Protocol_Exception(String message)
Construct a Theater_Protocol_Exception with a message.
|
Theater_Protocol_Exception(String message,
int reason)
Construct a Theater_Protocol_Exception with a message and reason.
|
Theater_Protocol_Exception(String message,
int reason,
Throwable cause)
Construct a Theater_Protocol_Exception with a message, reason and cause.
|
Theater_Protocol_Exception(String message,
Throwable cause)
Construct a Theater_Protocol_Exception with a message and cause.
|
Theater_Protocol_Exception(Throwable cause)
Construct a Theater_Protocol_Exception with a cause.
|
Modifier and Type | Method and Description |
---|---|
int |
Reason()
Get the Reason code for the exception.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public static final String ID
public static final int UNSPECIFIED
reason
code indicating that categorization
of the exception was not specified.public static final int TIMEOUT
reason
code indicating that the operation did
not complete within the allowed timeout period.public static final int UNAUTHENTICATED
reason
code indicating that the identity
authentication during the initial handshake with the Stage_Manager
was not successful.public static final int INVALID_MESSAGE
reason
code indicating that a protocol Message
contained invalid content.public Theater_Protocol_Exception(String message, int reason, Throwable cause)
message
- A message String providing a context dependent
description for the exception. May be null.reason
- An integer indicating the category of the reason for the
exception.cause
- A Throwable that caused this Theater_Protocol_Exception
to be thrown.May be null.Throwable.getMessage()
,
Reason()
,
Throwable.getCause()
public Theater_Protocol_Exception(String message, int reason)
A cause
will not be intialized.
message
- A message String providing a context dependent
description for the exception. May be null.reason
- An integer indicating the category of the reason for the
exception.Throwable.getMessage()
,
Reason()
public Theater_Protocol_Exception(int reason, Throwable cause)
reason
- An integer indicating the category of the reason for the
exception.cause
- A Throwable that caused this Theater_Protocol_Exception
to be thrown.May be null.Reason()
,
Throwable.getCause()
public Theater_Protocol_Exception(String message, Throwable cause)
The reason
for the exception will be UNSPECIFIED
.
message
- A message String providing a context dependent
description for the exception. May be null.cause
- A Throwable that caused this Theater_Protocol_Exception
to be thrown.May be null.Throwable.getMessage()
,
Throwable.getCause()
public Theater_Protocol_Exception(String message)
The reason
for the exception will be UNSPECIFIED
.
A cause
will not be intialized.
message
- A message String providing a context dependent
description for the exception. May be null.Throwable.getMessage()
public Theater_Protocol_Exception(Throwable cause)
The exception message
will be set to
the ID
of this class.
The reason
for the exception will be UNSPECIFIED
.
cause
- A Throwable that caused this Theater_Protocol_Exception
to be thrown.May be null.Throwable.getCause()
public Theater_Protocol_Exception()
public int Reason()
The common reason codes known to Theater_Protocol_Exception are:
UNSPECIFIED
TIMEOUT
UNAUTHENTICATED
INVALID_MESSAGE
N.B.: Other reason codes may be used, and the common reason codes may be used for other than the expected meaning. The descriptions listed above are the uses that are known.