|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectThrowable
Exception
javax.wvcm.WvcmException
com.ibm.rational.wvcm.stp.StpException
public abstract class StpException
An extension of javax.wvcm.WvcmException
used throughout this API. Although API methods are declared to throw
WvcmException, the exception actually thrown is StpException or one of its
subclasses.
This class extends the WvcmException class, adding a sub-reason code
field that encodes conditions specific to this API more finely than the
WvcmException.ReasonCode
This class (unlike the WvcmException class) leverages the Java 1.4 chained
exception mechanism. By default, if an StpException is constructed from one
or more nested Throwables, the first nested Throwable in the list is also set
as the StpException's cause
. In
certain special cases, the cause may be set to something other than the first
nested Throwable.
Exception classes that extend StpException because they convey additional
information, are as follows:
StpPropertyException
- adds name of property responsible for the
exception
StpPartialResultsException
- holds a ResourceList of child
resources successfully received, a nested list of Exceptions for child
resources that could not be retrieved, and an indicator of whether the two
lists completely identify all resources that were supposed to be retrieved.
Nested Class Summary | |
---|---|
static interface |
StpException.Data
The specification for the data implementation object associated with this exception. |
static class |
StpException.StpReasonCode
An encoding of exception conditions specific to this API. |
Nested classes/interfaces inherited from class javax.wvcm.WvcmException |
---|
WvcmException.ReasonCode |
Method Summary | ||
---|---|---|
abstract StpException.Data |
data()
|
|
String |
getMessage()
Localizes the message contained within this exception and returns it. |
|
StpException.StpReasonCode |
getStpReasonCode()
|
|
String |
toString()
|
|
static
|
unchecked_cast(Object obj)
Casts an Object to a Type, avoiding a type safety warning. |
Methods inherited from class javax.wvcm.WvcmException |
---|
getNestedExceptions, getReasonCode, getResource |
Methods inherited from class Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace |
Methods inherited from class Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public abstract StpException.Data data()
public String getMessage()
getMessage
in class Throwable
public StpException.StpReasonCode getStpReasonCode()
public String toString()
toString
in class Throwable
public static <U> U unchecked_cast(Object obj)
StpException.<desired-type>unchecked_cast(x)The ugliness of this construct matches the sledge hammer that is being used to make the code compile without warnings.
U
- The Type to which the object should be castobj
- The Object to be cast
|
Generated Tue 25-Jul-2017 08:41 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |