com.starteam.exceptions

Class SDKRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.starteam.exceptions.SDKRuntimeException

All Implemented Interfaces:

java.io.Serializable

public final 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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Return a unique error code that identified this exception May return NULL if this exception is aggregated from other exceptions such as I/O or Server exceptions
java.lang.Throwable	getException() Returns the exception that underlies the SDKRuntimeException being thrown.
java.lang.Object	getReason() return the artifact responsible for this exception
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

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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. Typically returns either a ServerException, or a java.io.IOException

getReason

public java.lang.Object getReason()

return the artifact responsible for this exception

Returns:

the artifact responsible for this exception

getErrorCode

public java.lang.String getErrorCode()

Return a unique error code that identified this exception May return NULL if this exception is aggregated from other exceptions such as I/O or Server exceptions

Returns:

a unique error code or NULL

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.

Parameters:

throwable - The exception to be checked if it's an internal SDK error.