com.crystaldecisions.sdk.occa.report.lib
Class ReportSDKExceptionBase

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKExceptionBase
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ReportSDKException

public abstract class ReportSDKExceptionBase
extends java.lang.Exception

For internal use only.

See Also:
Serialized Form

Constructor Summary
ReportSDKExceptionBase(int errorCode, java.lang.String errorMsg)
          Deprecated. As of version 4.0. Replaced by ReportSDKExceptionBase.ReportSDKExceptionBase(String, int, String).
ReportSDKExceptionBase(int errorCode, java.lang.String errorMsg, java.lang.Throwable cause)
          Deprecated. As of version 4.0. Replaced by ReportSDKExceptionBase.ReportSDKExceptionBase(String, int, String, Throwable).
ReportSDKExceptionBase(java.lang.String RCI, int errorCode, java.lang.String errorMsg)
          For internal use only.
ReportSDKExceptionBase(java.lang.String RCI, int errorCode, java.lang.String errorMsg, java.lang.Throwable cause)
          For internal use only.
 
Method Summary
 int errorCode()
          For internal use only.
 java.lang.Throwable findCause(java.lang.Class throwable)
          Digs into the cause chain to find a cause of the specified type.
 java.lang.String getRootCauseIdentifier()
          Gets the root cause identifier (RCI), which can help narrow down the source of a failure.
 boolean isCausedByA(java.lang.Class throwable)
          Digs into the cause chain to see if this exception was caused by the specified type of throwable.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportSDKExceptionBase

@Deprecated
public ReportSDKExceptionBase(int errorCode,
                                         java.lang.String errorMsg)
Deprecated. As of version 4.0. Replaced by ReportSDKExceptionBase.ReportSDKExceptionBase(String, int, String).

For internal use only.


ReportSDKExceptionBase

@Deprecated
public ReportSDKExceptionBase(int errorCode,
                                         java.lang.String errorMsg,
                                         java.lang.Throwable cause)
Deprecated. As of version 4.0. Replaced by ReportSDKExceptionBase.ReportSDKExceptionBase(String, int, String, Throwable).

For internal use only.


ReportSDKExceptionBase

public ReportSDKExceptionBase(java.lang.String RCI,
                              int errorCode,
                              java.lang.String errorMsg)
For internal use only.


ReportSDKExceptionBase

public ReportSDKExceptionBase(java.lang.String RCI,
                              int errorCode,
                              java.lang.String errorMsg,
                              java.lang.Throwable cause)
For internal use only.

Method Detail

errorCode

public int errorCode()
For internal use only.


getRootCauseIdentifier

public java.lang.String getRootCauseIdentifier()
Gets the root cause identifier (RCI), which can help narrow down the source of a failure.

Returns:
A string that uniquely identifies the source of the exception. May be null if none was provided.

toString

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

isCausedByA

public boolean isCausedByA(java.lang.Class throwable)
Digs into the cause chain to see if this exception was caused by the specified type of throwable.

Parameters:
throwable - The Class instance for the throwable we are looking for.
Returns:
whether a throwable of the specified type was found in the cause chain

findCause

public java.lang.Throwable findCause(java.lang.Class throwable)
Digs into the cause chain to find a cause of the specified type. The most outer cause that is an instance of the provided type is returned.

Parameters:
throwable - The Class instance for the exception we are looking for.
Returns:
The outermost cause of the specified type. null if not found.