Skip navigation links

com.stellent.cis.common.exception
Class BaseException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.stellent.cis.common.exception.BaseException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CommandException, ParameterValidationException, SCSException

public class BaseException

extends java.lang.Exception

Base exception class that keeps a chain of parent exceptions. Can be used on non JDK 1.4 environments.

See Also:

Serialized Form

Field Summary

protected boolean	m_hasMessage
protected boolean	m_isWrapper

Constructor Summary

BaseException()

BaseException(java.lang.String message)

BaseException(java.lang.String message, java.lang.Throwable cause)

BaseException(java.lang.Throwable cause)

Method Summary

java.lang.String	getMessage() Returns the detail message string of this throwable.
java.lang.Throwable	getRootCause() Unrolls the exception stack and returns the last error in the stack
boolean	isWrapper() Determines if this exception just holds another exception and provides no more contextual information.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_isWrapper

protected boolean m_isWrapper

m_hasMessage

protected boolean m_hasMessage

Constructor Detail

BaseException

public BaseException()

BaseException

public BaseException(java.lang.String message)

BaseException

public BaseException(java.lang.String message,
                     java.lang.Throwable cause)

BaseException

public BaseException(java.lang.Throwable cause)

Method Detail

isWrapper

public boolean isWrapper()

Determines if this exception just holds another exception and provides no more contextual information. Useful for displaying error messages without the command stack trace; i.e.

Returns:

true if this is a wrapper exception

getRootCause

public java.lang.Throwable getRootCause()

Unrolls the exception stack and returns the last error in the stack

Returns:

the root exception class

getMessage

public java.lang.String getMessage()

Returns the detail message string of this throwable. If this throwable was constructed without a message, then return the rootCause() message. (Effectively removing the classname from the message)

Overrides:

getMessage in class java.lang.Throwable

Returns:

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

Skip navigation links