org.seedstack.shed.exception

Class BaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.seedstack.shed.exception.BaseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SeedException

public abstract class BaseException
extends RuntimeException

This is the base class for all technical SeedStack exceptions. It provides additional information over traditional exception: detailed message, fix advice and online URL. Extra attributes can be added to the exception and used in message templates.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseException(ErrorCode errorCode) Create a BaseException from an ErrorCode.
protected	BaseException(ErrorCode errorCode, Throwable cause) Create a BaseException from an ErrorCode wrapping a Throwable.

Method Summary

Modifier and Type	Method and Description
static <E extends BaseException> E	createNew(Class<E> exceptionType, ErrorCode errorCode) Create a new subclass of BaseException from an ErrorCode.
<T> T	get(String name) Return a property of this exception.
List<String>	getCauses() Provides a list describing the causes of this exception.
String	getDescription() Provides additional information beyond the short message.
ErrorCode	getErrorCode() Retrieve the ErrorCode of this exception.
String	getFix() Provides advice on how to fix the root cause of the exception.
Map<String,Object>	getProperties() Return the properties of this exception.
String	getUrl() Provides an URL to online information about the root cause of the exception.
<E extends BaseException> E	put(String name, Object value) Put a property in this exception.
String	toString() The toString() method is overloaded to provide additional exception details.
static <E extends BaseException> E	wrap(Class<E> exceptionType, Throwable throwable, ErrorCode errorCode) Wrap a subclass of BaseException with an ErrorCode around an existing Throwable.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseException

protected BaseException(ErrorCode errorCode)

Create a BaseException from an ErrorCode.

Parameters:

errorCode - the error code.

BaseException

protected BaseException(ErrorCode errorCode,
                        Throwable cause)

Create a BaseException from an ErrorCode wrapping a Throwable.

Parameters:

errorCode - the error code.

cause - the cause of this exception if any.

Method Detail

createNew

public static <E extends BaseException> E createNew(Class<E> exceptionType,
                                                    ErrorCode errorCode)

Create a new subclass of BaseException from an ErrorCode.

Type Parameters:

E - the subtype.

Parameters:

exceptionType - the subclass of BaseException to create.

errorCode - the error code to set.

Returns:

the created BaseException.

wrap

public static <E extends BaseException> E wrap(Class<E> exceptionType,
                                               Throwable throwable,
                                               ErrorCode errorCode)

Wrap a subclass of BaseException with an ErrorCode around an existing Throwable.

Type Parameters:

E - the subtype.

Parameters:

exceptionType - the subclass of BaseException to create.

throwable - the existing throwable to wrap.

errorCode - the error code to set.

Returns:

the created BaseException.

getErrorCode

public ErrorCode getErrorCode()

Retrieve the ErrorCode of this exception.

Returns:

the error code instance.

getProperties

public Map<String,Object> getProperties()

Return the properties of this exception.

Returns:

the map of the properties.

get

public <T> T get(String name)

Return a property of this exception.

Type Parameters:

T - the type of the property.

Parameters:

name - the name of the property.

Returns:

the value of the property.

put

public <E extends BaseException> E put(String name,
                                       Object value)

Put a property in this exception.

Type Parameters:

E - the type fo the property.

Parameters:

name - the name of the property.

value - the value of the property.

Returns:

this exception (to chain calls).

toString

public String toString()

The toString() method is overloaded to provide additional exception details. When invoked directly it only returns the details of this exception. When invoked from printStackTrace() it returns the details of this exception and flags all causes of BaseException type to only display their short message when their toString() method will be invoked by printStacktrace(). This uses a ThreadLocal implementation of the flag to stay thread-safe.

Overrides:

toString in class Throwable

Returns:

a textual representation of the exception.

getDescription

public String getDescription()

Provides additional information beyond the short message.

Returns:

the exception description or null if none exists.

getCauses

public List<String> getCauses()

Provides a list describing the causes of this exception. This list is built by iterating through this exception causes and storing the description through getDescription() if present or the message through Throwable.getMessage() as a fallback.

Returns:

the list of causes, possibly empty.

getFix

public String getFix()

Provides advice on how to fix the root cause of the exception. This fix is effectively extracted from the last cause available.

Returns:

the fix of the root cause or null if none exists.

getUrl

public String getUrl()

Provides an URL to online information about the root cause of the exception. This URL is effectively extracted from the last cause available.

Returns:

the online information URL of the root cause or null if none exists.