org.starchartlabs.alloy.core

Class Throwables

java.lang.Object

org.starchartlabs.alloy.core.Throwables

public final class Throwables
extends java.lang.Object

Utilities intended to enhance and streamline use of Throwable

Since:

0.2.0

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Throwable>	getCausalChain(java.lang.Throwable throwable) Gets a Throwable cause chain as a list.
static java.lang.Throwable	getRootCause(java.lang.Throwable throwable) Returns the innermost cause of throwable.
static java.lang.String	getStackTraceAsString(java.lang.Throwable throwable) Returns a string containing the result of toString(), followed by the full, recursive stack trace of throwable.
static <X extends java.lang.Throwable> void	throwIfInstanceOf(java.lang.Throwable throwable, java.lang.Class<X> declaredType) Throws throwable if it is an instance of declaredType
static void	throwIfUnchecked(java.lang.Throwable throwable) Throws throwable if it is a RuntimeException or Error

Methods inherited from class java.lang.Object

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

Method Detail

throwIfInstanceOf

public static <X extends java.lang.Throwable> void throwIfInstanceOf(java.lang.Throwable throwable,
                                                                     java.lang.Class<X> declaredType)
                                                              throws X extends java.lang.Throwable

Throws throwable if it is an instance of declaredType

Type Parameters:

X - The type to check against the provided throwable

Parameters:

throwable - The throwable to type check and throw if an instance of specified type

declaredType - The type to check against the provided throwable

Throws:

X - If the provided throwable is an instance of X

X extends java.lang.Throwable

Since:

0.2.0

throwIfUnchecked

public static void throwIfUnchecked(java.lang.Throwable throwable)

Throws throwable if it is a RuntimeException or Error

Parameters:

throwable - The throwable to type check and throw if an instance of a runtime issue

Since:

0.2.0

getRootCause

public static java.lang.Throwable getRootCause(java.lang.Throwable throwable)

Returns the innermost cause of throwable. The first throwable in a chain provides context from when the error or exception was initially detected

 assertEquals("Unable to assign a customer id", Throwables.getRootCause(e).getMessage());
 

Parameters:

throwable - The throwable to walk the cause trace of and find the root

Returns:

The root of the cause chain in the provided throwable

Since:

0.2.0

getCausalChain

public static java.util.List<java.lang.Throwable> getCausalChain(java.lang.Throwable throwable)

Gets a Throwable cause chain as a list. The first entry in the list will be throwable followed by its cause hierarchy. Note that this is a snapshot of the cause chain and will not reflect any subsequent changes to the cause chain.

Parameters:

throwable - The Throwable to extract causes from

Returns:

An unmodifiable list containing the cause chain starting with throwable

Since:

0.2.0

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Throwable throwable)

Returns a string containing the result of toString(), followed by the full, recursive stack trace of throwable. Note that you probably should not be parsing the resulting string; if you need programmatic access to the stack frames, call Throwable.getStackTrace()

Parameters:

throwable - Representation of the error to get stack trace information from

Returns:

String representation of the call sequence which resulted in the error

Since:

0.2.0