Package org.kiwiproject.base

Class KiwiThrowables

java.lang.Object

org.kiwiproject.base.KiwiThrowables

public final class KiwiThrowables
extends Object

Utility class for working with Throwable instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KiwiThrowables.ThrowableInfo	Immutable "struct" that contains information from a Throwable instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final KiwiThrowables.ThrowableInfo	EMPTY_THROWABLE_INFO	Represents an "empty" KiwiThrowables.ThrowableInfo, which is when the Throwable it comes from is null.

Method Summary

Modifier and Type	Method	Description
static KiwiThrowables.ThrowableInfo	emptyThrowableInfo()	Get the singleton "empty" instance.
static Optional<String>	messageOf(Throwable throwable)	Get the message of Throwable
static Optional<String>	messageOfNullable(@Nullable Throwable throwable)	Get the message from Throwable or Optional.empty() if throwable is null.
static Optional<Throwable>	nextCauseOf(Throwable throwable)	Get the direct cause of the Throwable.
static Optional<Throwable>	nextCauseOfNullable(@Nullable Throwable throwable)	Get the direct cause of the Throwable or Optional.empty() if throwable is null.
static Optional<Throwable>	rootCauseOf(Throwable throwable)	Get the root cause of the Throwable.
static Optional<Throwable>	rootCauseOfNullable(@Nullable Throwable throwable)	Get the root cause of the Throwable or Optional.empty() if throwable is null.
static String	stackTraceOf(Throwable throwable)	Simply wraps the Apache Commons' ExceptionUtils.getStackTrace(Throwable) method.
static Optional<String>	stackTraceOfNullable(@Nullable Throwable throwable)	Simply wraps the Apache Commons' ExceptionUtils.getStackTrace(Throwable) method.
static KiwiThrowables.ThrowableInfo	throwableInfoOfNonNull(Throwable throwable)	Create a KiwiThrowables.ThrowableInfo from given Throwable.
static Optional<KiwiThrowables.ThrowableInfo>	throwableInfoOfNullable(@Nullable Throwable throwable)	Create a KiwiThrowables.ThrowableInfo from given Throwable.
static String	typeOf(Throwable throwable)	Get the type of Throwable
static Optional<String>	typeOfNullable(@Nullable Throwable throwable)	Get the type of Throwable or Optional.empty() if throwable is null
static Throwable	unwrap(Throwable throwable, Class<?> wrapperClass)	If throwable is of type wrapperClass, then "unwrap" the cause and return it.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_THROWABLE_INFO

public static final KiwiThrowables.ThrowableInfo EMPTY_THROWABLE_INFO

Represents an "empty" KiwiThrowables.ThrowableInfo, which is when the Throwable it comes from is null.

Method Details

emptyThrowableInfo

public static KiwiThrowables.ThrowableInfo emptyThrowableInfo()

Get the singleton "empty" instance.

Returns:

the "empty" ThrowableInfo singleton instance

See Also:

• EMPTY_THROWABLE_INFO

throwableInfoOfNonNull

public static KiwiThrowables.ThrowableInfo throwableInfoOfNonNull(Throwable throwable)

Create a KiwiThrowables.ThrowableInfo from given Throwable.

Parameters:

throwable - a Throwable instance

Returns:

a KiwiThrowables.ThrowableInfo instance

Throws:

IllegalArgumentException - if throwable is null

throwableInfoOfNullable

public static Optional<KiwiThrowables.ThrowableInfo> throwableInfoOfNullable(@Nullable Throwable throwable)

Create a KiwiThrowables.ThrowableInfo from given Throwable.

Parameters:

throwable - a Throwable instance

Returns:

a KiwiThrowables.ThrowableInfo instance

Throws:

IllegalArgumentException - if throwable is null

nextCauseOf

public static Optional<Throwable> nextCauseOf(Throwable throwable)

Get the direct cause of the Throwable.

Parameters:

throwable - the Throwable to analyze

Returns:

the direct cause

Throws:

IllegalArgumentException - if throwable is null

nextCauseOfNullable

public static Optional<Throwable> nextCauseOfNullable(@Nullable Throwable throwable)

Get the direct cause of the Throwable or Optional.empty() if throwable is null.

Parameters:

throwable - the Throwable to analyze

Returns:

the direct cause

rootCauseOf

public static Optional<Throwable> rootCauseOf(Throwable throwable)

Get the root cause of the Throwable.

Parameters:

throwable - the Throwable to analyze

Returns:

the root cause

Throws:

IllegalArgumentException - if throwable if null

rootCauseOfNullable

public static Optional<Throwable> rootCauseOfNullable(@Nullable Throwable throwable)

Get the root cause of the Throwable or Optional.empty() if throwable is null.

Parameters:

throwable - the Throwable to analyze

Returns:

the root cause

Throws:

IllegalArgumentException - if throwable if null

typeOf

public static String typeOf(Throwable throwable)

Get the type of Throwable

Parameters:

throwable - the Throwable to analyze

Returns:

the type

Throws:

IllegalArgumentException - if throwable is null

typeOfNullable

public static Optional<String> typeOfNullable(@Nullable Throwable throwable)

Get the type of Throwable or Optional.empty() if throwable is null

Parameters:

throwable - the Throwable to analyze

Returns:

the type

messageOf

public static Optional<String> messageOf(Throwable throwable)

Get the message of Throwable

Parameters:

throwable - the Throwable to analyze

Returns:

the message, if present, or Optional.empty() if not

Throws:

IllegalArgumentException - if throwable is null

messageOfNullable

public static Optional<String> messageOfNullable(@Nullable Throwable throwable)

Get the message from Throwable or Optional.empty() if throwable is null.

Parameters:

throwable - the Throwable to analyze

Returns:

the message, if present or Optional.empty() if not

stackTraceOf

public static String stackTraceOf(Throwable throwable)

Simply wraps the Apache Commons' ExceptionUtils.getStackTrace(Throwable) method. Mainly here to make it easy to obtain a stack trace while staying in the same KiwiThrowables API.

Parameters:

throwable - the Throwable instance

Returns:

the stack trace of the throwable, or null

Throws:

IllegalArgumentException - if throwable is null

stackTraceOfNullable

public static Optional<String> stackTraceOfNullable(@Nullable Throwable throwable)

Simply wraps the Apache Commons' ExceptionUtils.getStackTrace(Throwable) method. Mainly here to make it easy to obtain a stack trace while staying in the same KiwiThrowables API.

Parameters:

throwable - the Throwable instance

Returns:

the stack trace of the throwable, or null

Throws:

IllegalArgumentException - if throwable is null

unwrap

public static Throwable unwrap(Throwable throwable,
 Class<?> wrapperClass)

If throwable is of type wrapperClass, then "unwrap" the cause and return it. Otherwise return throwable

Parameters:

throwable - the Throwable to unwrap if its class matches

wrapperClass - the typ eof class to match

Returns:

the unwrapped Throwable or the original throwable