org.spf4j.base

Class Throwables

java.lang.Object

org.spf4j.base.Throwables

@ParametersAreNonnullByDefault
public final class Throwables
extends Object

utility class for throwables.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Throwables.PackageDetail enum describing the PackageDetail level to be logged in the stack trace.
static class	Throwables.TrimmedException

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAUSE_CAPTION Caption for labeling causative exception stack traces
static int	MAX_THROWABLE_CHAIN
static String	SUPPRESSED_CAPTION Caption for labeling suppressed exception stack traces

Method Summary

Modifier and Type	Method and Description
static <T extends Throwable> T	chain(T t, Throwable newRootCause) This method will clone the exception t and will set a new root cause.
static <T extends Throwable> T	chain(T t, Throwable newRootCause, int maxChained)
static int	commonFrames(StackTraceElement[] trace, StackTraceElement[] enclosingTrace)
static boolean	contains(Throwable t, Predicate<Throwable> predicate) checks in the throwable + children (both causal and suppressed) contain a throwable that respects the Predicate.
static boolean	containsNonRecoverable(Throwable t) Does this Throwable contain a JVM non-recoverable exception.
static <T extends Throwable> T	first(Throwable t, Class<T> clasz) return first Exception in the causal chain Assignable to clasz.
static Throwable	first(Throwable t, Predicate<Throwable> predicate) Returns the first Throwable that matches the predicate in the causal and suppressed chain, the suppressed chain includes the supression mechanism included in SQLException.
static Throwable	firstCause(Throwable throwable, Predicate<Throwable> predicate) Returns first Throwable in the causality chain that is matching the provided predicate.
static Predicate<Throwable>	getIsRetryablePredicate()
static Predicate<Throwable>	getNonRecoverablePredicate()
static int	getNrRecursiveSuppressedExceptions(Throwable t)
static int	getNrSuppressedExceptions(Throwable t)
static Throwable[]	getSuppressed(Throwable t) Utility to get suppressed exceptions.
static boolean	isNonRecoverable(Throwable t) Is this Throwable a JVM non-recoverable exception.
static boolean	isRetryable(Exception value) figure out if a Exception is retry-able or not.
static Throwable	removeOldestSuppressed(Throwable t)
static Throwable	removeOldestSuppressedRecursive(Throwable t)
static void	setIsRetryablePredicate(Predicate<Throwable> isRetryablePredicate)
static void	setNonRecoverablePredicate(Predicate<Throwable> predicate) Overwrite the default non-recoverable predicate.
static <T extends Throwable> T	suppress(T t, Throwable suppressed) Functionality similar for java 1.7 Throwable.addSuppressed.
static <T extends Throwable> T	suppress(T t, Throwable suppressed, int maxSuppressed)
static void	throwException(Exception ex)
static String	toString(Throwable t)
static String	toString(Throwable t, Throwables.PackageDetail detail)
static String	toString(Throwable t, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)
static StringBuilder	toStringBuilder(Throwable t, Throwables.PackageDetail detail)
static StringBuilder	toStringBuilder(Throwable t, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)
static void	trimCausalChain(Throwable t, int maxSize)
static void	writeAbreviatedClassName(String className, Appendable writeTo)
static void	writeMessageString(Appendable to, Throwable t)
static void	writeTo(StackTraceElement[] trace, Appendable to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)
static void	writeTo(StackTraceElement[] trace, Appendable to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement, String prefix)
static void	writeTo(StackTraceElement element, StackTraceElement previous, Appendable to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)
static void	writeTo(Throwable t, Appendable to, Throwables.PackageDetail detail)
static void	writeTo(Throwable t, Appendable to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)
static void	writeTo(Throwable t, Appendable to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement, String prefix)
static void	writeTo(Throwable t, Appendable to, Throwables.PackageDetail detail, String prefix)
static void	writeTo(Throwable t, PrintStream to, Throwables.PackageDetail detail)
static void	writeTo(Throwable t, PrintStream to, Throwables.PackageDetail detail, boolean abbreviatedTraceElement)

Methods inherited from class java.lang.Object

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

Field Detail

SUPPRESSED_CAPTION

public static final String SUPPRESSED_CAPTION

Caption for labeling suppressed exception stack traces

See Also:

Constant Field Values

CAUSE_CAPTION

public static final String CAUSE_CAPTION

Caption for labeling causative exception stack traces

See Also:

Constant Field Values

MAX_THROWABLE_CHAIN

public static final int MAX_THROWABLE_CHAIN

Method Detail

isRetryable

public static boolean isRetryable(Exception value)

figure out if a Exception is retry-able or not. If while executing a operation a exception is returned, that exception is retryable if retrying the operation can potentially succeed.

Parameters:

value -

Returns:

getIsRetryablePredicate

public static Predicate<Throwable> getIsRetryablePredicate()

setIsRetryablePredicate

public static void setIsRetryablePredicate(Predicate<Throwable> isRetryablePredicate)

getNrSuppressedExceptions

public static int getNrSuppressedExceptions(Throwable t)

getNrRecursiveSuppressedExceptions

public static int getNrRecursiveSuppressedExceptions(Throwable t)

removeOldestSuppressedRecursive

@Nullable
public static Throwable removeOldestSuppressedRecursive(Throwable t)

removeOldestSuppressed

@Nullable
public static Throwable removeOldestSuppressed(Throwable t)

chain

public static <T extends Throwable> T chain(T t,
                                            Throwable newRootCause)

This method will clone the exception t and will set a new root cause.

Type Parameters:

T -

Parameters:

t -

newRootCause -

Returns:

chain

public static <T extends Throwable> T chain(T t,
                                            Throwable newRootCause,
                                            int maxChained)

trimCausalChain

public static void trimCausalChain(Throwable t,
                                   int maxSize)

suppress

@CheckReturnValue
public static <T extends Throwable> T suppress(@Nonnull
                                                                 T t,
                                                                 @Nonnull
                                                                 Throwable suppressed)

Functionality similar for java 1.7 Throwable.addSuppressed. 2 extra things happen: 1) limit to nr of exceptions suppressed. 2) Suppression does not mutate Exception, it clones it.

Type Parameters:

T -

Parameters:

t -

suppressed -

Returns:

suppress

@CheckReturnValue
public static <T extends Throwable> T suppress(@Nonnull
                                                                 T t,
                                                                 @Nonnull
                                                                 Throwable suppressed,
                                                                 int maxSuppressed)

getSuppressed

public static Throwable[] getSuppressed(Throwable t)

Utility to get suppressed exceptions. In java 1.7 it will return t.getSuppressed() + in case it is Iterable any other linked exceptions (see SQLException) java 1.6 behavior is deprecated.

Parameters:

t -

Returns:

writeTo

public static void writeTo(StackTraceElement element,
                           @Nullable
                           StackTraceElement previous,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement)
                    throws IOException

Throws:

IOException

toString

public static String toString(Throwable t)

toString

public static String toString(Throwable t,
                              Throwables.PackageDetail detail)

toString

public static String toString(Throwable t,
                              Throwables.PackageDetail detail,
                              boolean abbreviatedTraceElement)

toStringBuilder

public static StringBuilder toStringBuilder(Throwable t,
                                            Throwables.PackageDetail detail)

toStringBuilder

public static StringBuilder toStringBuilder(Throwable t,
                                            Throwables.PackageDetail detail,
                                            boolean abbreviatedTraceElement)

writeTo

public static void writeTo(@Nonnull
                           Throwable t,
                           @Nonnull
                           PrintStream to,
                           @Nonnull
                           Throwables.PackageDetail detail)

writeTo

public static void writeTo(@Nonnull
                           Throwable t,
                           @Nonnull
                           PrintStream to,
                           @Nonnull
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement)

writeTo

public static void writeTo(Throwable t,
                           Appendable to,
                           Throwables.PackageDetail detail)
                    throws IOException

Throws:

IOException

writeTo

public static void writeTo(Throwable t,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           String prefix)
                    throws IOException

Throws:

IOException

writeTo

public static void writeTo(Throwable t,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement)
                    throws IOException

Throws:

IOException

writeTo

public static void writeTo(Throwable t,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement,
                           String prefix)
                    throws IOException

Throws:

IOException

writeMessageString

public static void writeMessageString(Appendable to,
                                      Throwable t)
                               throws IOException

Throws:

IOException

writeTo

public static void writeTo(StackTraceElement[] trace,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement)
                    throws IOException

Throws:

IOException

writeTo

public static void writeTo(StackTraceElement[] trace,
                           Appendable to,
                           Throwables.PackageDetail detail,
                           boolean abbreviatedTraceElement,
                           String prefix)
                    throws IOException

Throws:

IOException

commonFrames

public static int commonFrames(StackTraceElement[] trace,
                               StackTraceElement[] enclosingTrace)

isNonRecoverable

public static boolean isNonRecoverable(@Nonnull
                                       Throwable t)

Is this Throwable a JVM non-recoverable exception. (Oom, VMError, etc...)

Parameters:

t -

Returns:

containsNonRecoverable

public static boolean containsNonRecoverable(@Nonnull
                                             Throwable t)

Does this Throwable contain a JVM non-recoverable exception. (Oom, VMError, etc...)

Parameters:

t -

Returns:

contains

public static boolean contains(@Nonnull
                               Throwable t,
                               Predicate<Throwable> predicate)

checks in the throwable + children (both causal and suppressed) contain a throwable that respects the Predicate.

Parameters:

t - the throwable

predicate - the predicate

Returns:

true if a Throwable matching the predicate is found.

first

@Nullable
 @CheckReturnValue
public static <T extends Throwable> T first(@Nonnull
                                                                         Throwable t,
                                                                         Class<T> clasz)

return first Exception in the causal chain Assignable to clasz.

Type Parameters:

T -

Parameters:

t -

clasz -

Returns:

first

@Nullable
 @CheckReturnValue
public static Throwable first(@Nonnull
                                                           Throwable t,
                                                           Predicate<Throwable> predicate)

Returns the first Throwable that matches the predicate in the causal and suppressed chain, the suppressed chain includes the supression mechanism included in SQLException.

Parameters:

t - the Throwable

predicate - the Predicate

Returns:

the Throwable the first matches the predicate or null is none matches.

firstCause

@Nullable
 @CheckReturnValue
public static Throwable firstCause(@Nonnull
                                                                Throwable throwable,
                                                                Predicate<Throwable> predicate)

Returns first Throwable in the causality chain that is matching the provided predicate.

Parameters:

throwable - the Throwable to go through.

predicate - the predicate to apply

Returns:

the first Throwable from the chain that the predicate matches.

getNonRecoverablePredicate

public static Predicate<Throwable> getNonRecoverablePredicate()

setNonRecoverablePredicate

public static void setNonRecoverablePredicate(Predicate<Throwable> predicate)

Overwrite the default non-recoverable predicate.

Parameters:

predicate -

writeAbreviatedClassName

public static void writeAbreviatedClassName(String className,
                                            Appendable writeTo)
                                     throws IOException

Throws:

IOException

throwException

public static void throwException(Exception ex)
                           throws IOException,
                                  InterruptedException,
                                  ExecutionException,
                                  TimeoutException

Throws:

IOException

InterruptedException

ExecutionException

TimeoutException