com.starbase.starteam
Class SDKRuntimeException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.starbase.starteam.SDKRuntimeException

All Implemented Interfaces:

java.io.Serializable

public class SDKRuntimeException

extends java.lang.RuntimeException

This is a subclass of java.lang.RuntimeException which may be thrown by the SDK when a runtime error occurs. Note that not all exceptions thrown by the SDK will be subclasses of this class. This class is most often used when re-throwing an exception that was due to some other underlying cause. In those cases the SDKRuntimeException object may have have an associated underlying exception which was the root cause of the problem. This is very similar to the "chained exception" facility introduced in Java 1.4. However, since the StarTeam SDK was designed to work with Java 1.1, we could not use the 1.4 exception chaining mechanism but instead added our own getException method. NOTE: this class now works properly when used against a VM that is < 1.4, and also uses 1.4 functionality when it's available.

See Also:

Serialized Form

Constructor Summary

SDKRuntimeException(java.lang.String message)
We may extend this some day to include COM error codes.

SDKRuntimeException(java.lang.String message, java.lang.Throwable exception)
Constructor passing both a message and a contained exception.

SDKRuntimeException(java.lang.Throwable exception)
Constructor passing only a contained exception.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.Throwable	getException() Returns the exception that underlies the SDKRuntimeException being thrown.
java.lang.String	getMessage() Returns the detail message string of this throwable.
int	hashCode() returns a unique hash for all instances of this type
static boolean	isInternalApplicationError(java.lang.Throwable throwable) Returns true if the given Exception represents an internal SDK error; false, otherwise.
boolean	isInternalError() Returns true if this exception represents an internal SDK error; false, otherwise.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SDKRuntimeException

public SDKRuntimeException(java.lang.String message)

We may extend this some day to include COM error codes. Only the SDK itself should create instances of this class.

SDKRuntimeException

public SDKRuntimeException(java.lang.Throwable exception)

Constructor passing only a contained exception.

SDKRuntimeException

public SDKRuntimeException(java.lang.String message,
                           java.lang.Throwable exception)

Constructor passing both a message and a contained exception.

Method Detail

getException

public java.lang.Throwable getException()

Returns the exception that underlies the SDKRuntimeException being thrown. This may return null if there is no underlying exception.

getMessage

public java.lang.String getMessage()

Returns the detail message string of this throwable.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detail message string of this Throwable instance (which may be null).

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type

isInternalError

public boolean isInternalError()

Returns true if this exception represents an internal SDK error; false, otherwise.

isInternalApplicationError

public static boolean isInternalApplicationError(java.lang.Throwable throwable)

Returns true if the given Exception represents an internal SDK error; false, otherwise.