de.ipcon.tools

Class ThrowableTools

java.lang.Object

de.ipcon.tools.ThrowableTools

public class ThrowableTools
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map	DEFAULT_KNOWN_EXCEPTION_WRAPPERS

Method Summary

Modifier and Type	Method and Description
static void	dumpJVMStack()
static void	dumpJVMStack(java.io.PrintStream ps)
static void	dumpStack() Prints filtered stacktrace of calling thread to the given PrintStream (if not null, the default) or otherwise to System.err.
static void	dumpStack(java.lang.String msg)
static void	dumpStack(java.lang.String msg, java.io.PrintStream ps)
static void	filterAndDumpStackTrace(java.lang.String str) Reads a stacktrace given as String and dumps it to STDOUT in filtered form.
static java.lang.Throwable	filterStackTrace(java.lang.Throwable t) Filters the stack trace of a Throwable and its causes using default filters.
static java.lang.Throwable[]	getAllCauses(java.lang.Throwable t)
static java.lang.Throwable	getCause(java.lang.Throwable t) Finds the cause of the exception if it exists.
static java.lang.String	getCauseMethod(java.lang.Throwable t) Returns the method name needed to get the 'cause' of the given t.
static java.lang.Throwable	getCauseOfClass(java.lang.Class clazz, java.lang.Throwable t)
static java.lang.Throwable	getDeepestCauseOfClass(java.lang.Class clazz, java.lang.Throwable t)
static java.lang.String	getErrortext(java.lang.Exception ex) Generates and returns a text consisting of the given message (if any) and a string dump of the exception stacktrace slightly formatted to be used for storing as error info text with objects or similar.
static java.lang.String	getErrortext(java.lang.Exception ex, java.lang.String msg)
static java.lang.Throwable	getRootCause(java.lang.Throwable t) Recursively retrieves the root cause of a Throwable.
static java.lang.String	getStackTraceAsString(java.lang.Thread t)
static java.lang.String	getStackTraceAsString(java.lang.Thread t, boolean filtered)
static java.lang.String	getStackTraceAsString(java.lang.Thread t, OutputConfiguration outputConfig)
static java.lang.String	getStackTraceAsString(java.lang.Throwable t) Returns stacktrace of the given Throwable as String filtering out certain stack frames if requested.
static java.lang.String	getStackTraceAsString(java.lang.Throwable t, boolean filtered) Returns stacktrace of the given Throwable as String filtering out certain stack frames with default filtering if requested.
static java.lang.String	getStackTraceAsString(java.lang.Throwable t, OutputConfiguration outputConfig)
static java.lang.StackTraceElement	getStackTraceElement(java.lang.Throwable t, java.lang.String declaringClass, java.lang.String methodName) Helper method to extract a certain element/part of a stacktrace
static java.lang.StackTraceElement	getStackTraceElement(java.lang.Throwable t, java.lang.String declaringClass, java.lang.String methodName, java.lang.String fileName)
static java.lang.String	getUserRelevantMessage(java.lang.Throwable t) Extracts a user-relevant message from a throwable, optionally prioritizing a specific cause type.
static java.lang.String	getUserRelevantMessage(java.lang.Throwable t, java.lang.Class<? extends java.lang.Throwable> preferType)
static boolean	hasCauseOfClass(java.lang.Class clazz, java.lang.Throwable t)
static boolean	isKnownWrapperException(java.lang.Throwable t)
static void	printStackTrace(java.lang.StackTraceElement[] stackTraceEls, java.io.PrintWriter pw) Prints the given stacktrace to to the given PrintWriter filtering out certain stack frames if requested.
static void	printStackTrace(java.lang.StackTraceElement[] stackTraceEls, java.io.PrintWriter pw, OutputConfiguration outputConfig)
static void	printStackTrace(java.lang.StackTraceElement[] stackTraceEls, java.io.PrintWriter pw, OutputConfiguration outputConfig, int upToFrame)
static void	printStackTrace(java.lang.StackTraceElement[] stackTraceEls, java.io.PrintWriter pw, OutputConfiguration outputConfig, int upToFrame, int fromFrame)
static void	printStackTrace(java.lang.Throwable t, boolean filtered) Prints stacktrace of the given Throwable to System.err.
static void	printStackTrace(java.lang.Throwable t, java.io.PrintStream ps) Prints stacktrace of the given Throwable to to the given PrintStream filtering out certain stack frames if requested.
static void	printStackTrace(java.lang.Throwable t, java.io.PrintStream ps, boolean filtered) Prints stacktrace of the given Throwable to the given PrintStream, filtering out certain stack frames with default filtering if requested.
static void	printStackTrace(java.lang.Throwable t, java.io.PrintStream ps, OutputConfiguration outputConfig)
static void	printStackTrace(java.lang.Throwable t, java.io.PrintStream ps, OutputConfiguration outputConfig, int upToFrame)
static void	printStackTrace(java.lang.Throwable t, java.io.PrintStream ps, OutputConfiguration outputConfig, int upToFrame, int fromFrame)
static void	printStackTrace(java.lang.Throwable t, java.io.PrintWriter pw) Prints stacktrace of the given Throwable to to the given PrintWriter filtering out certain stack frames if requested.
static void	printStackTrace(java.lang.Throwable t, java.io.PrintWriter pw, OutputConfiguration outputConfig)
static void	printStackTrace(java.lang.Throwable t, java.io.PrintWriter pw, OutputConfiguration outputConfig, int upToFrame)
static void	printStackTrace(java.lang.Throwable t, java.io.PrintWriter pw, OutputConfiguration outputConfig, int upToFrame, int fromFrame)
static void	printStackTraceAsCause(java.lang.String cm, java.lang.Throwable t, java.io.PrintWriter pw, java.lang.StackTraceElement[] causedTrace, OutputConfiguration outputConfig)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KNOWN_EXCEPTION_WRAPPERS

public static final java.util.Map DEFAULT_KNOWN_EXCEPTION_WRAPPERS

Method Detail

getCause

public static java.lang.Throwable getCause(java.lang.Throwable t)

Finds the cause of the exception if it exists. Has some special handling for some older Throwables (from before Java 1.4) that use a differently named method with the same semantic as Throwable.getCause(). A nonnull result of getCause() is always preferred.

Parameters:

t - the nonnull throwable to get the cause.

Returns:

null, if there is no deeper cause, the cause otherwise.

getAllCauses

public static java.lang.Throwable[] getAllCauses(java.lang.Throwable t)

getCauseMethod

public static java.lang.String getCauseMethod(java.lang.Throwable t)

Returns the method name needed to get the 'cause' of the given t.

Parameters:

t - a to get the 'cause' method of

Returns:

the name of the method needed to get the 'cause'

getRootCause

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

Recursively retrieves the root cause of a Throwable.

This method traverses the cause chain of the given Throwable and returns the ultimate cause, i.e., the Throwable that has no further cause.

Parameters:

t - The Throwable for which to retrieve the root cause.

Returns:

The root cause of the Throwable.

getUserRelevantMessage

public static java.lang.String getUserRelevantMessage(java.lang.Throwable t)

Extracts a user-relevant message from a throwable, optionally prioritizing a specific cause type.

This method retrieves a message suitable for displaying to the user from the given throwable. It prioritizes a cause of the specified preferType if provided, falling back to the deepest unchecked exception or the root cause otherwise. Any irrelevant prefix marking the message as originating from the backend is removed from the message before returning it.

Parameters:

t - The throwable from which to extract the message.

preferType - The preferred type of cause to extract the message from, or null to use the deepest unchecked exception or the root cause.

Returns:

The user-relevant message, or null if the throwable is null.

getUserRelevantMessage

public static java.lang.String getUserRelevantMessage(java.lang.Throwable t,
                                                      java.lang.Class<? extends java.lang.Throwable> preferType)

hasCauseOfClass

public static boolean hasCauseOfClass(java.lang.Class clazz,
                                      java.lang.Throwable t)

getCauseOfClass

public static java.lang.Throwable getCauseOfClass(java.lang.Class clazz,
                                                  java.lang.Throwable t)

getDeepestCauseOfClass

public static java.lang.Throwable getDeepestCauseOfClass(java.lang.Class clazz,
                                                         java.lang.Throwable t)

isKnownWrapperException

public static boolean isKnownWrapperException(java.lang.Throwable t)

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Throwable t,
                                                     boolean filtered)

Returns stacktrace of the given Throwable as String filtering out certain stack frames with default filtering if requested.

Parameters:

t - the Throwable whose stacktrace should be returned

filtered - if true filter out uninteresting stack frames; if false include all stack frames

Returns:

the stacktrace as String

getStackTraceAsString

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

Returns stacktrace of the given Throwable as String filtering out certain stack frames if requested.

Parameters:

t - the Throwable whose stacktrace should be returned

outputConfig - a OutputConfiguration to configure text written to s

Returns:

the stacktrace as String

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Throwable t,
                                                     OutputConfiguration outputConfig)

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Thread t,
                                                     boolean filtered)

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Thread t)

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Thread t,
                                                     OutputConfiguration outputConfig)

dumpStack

public static void dumpStack()

Prints filtered stacktrace of calling thread to the given PrintStream (if not null, the default) or otherwise to System.err.

dumpStack

public static void dumpStack(java.lang.String msg)

dumpStack

public static void dumpStack(java.lang.String msg,
                             java.io.PrintStream ps)

dumpJVMStack

public static void dumpJVMStack()

dumpJVMStack

public static void dumpJVMStack(java.io.PrintStream ps)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   boolean filtered)

Prints stacktrace of the given Throwable to System.err.

Parameters:

t - the Throwable whose stacktrace should be printed

filtered - if true filter out uninteresting stack frames; if false print out all stack frames

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintStream ps,
                                   boolean filtered)

Prints stacktrace of the given Throwable to the given PrintStream, filtering out certain stack frames with default filtering if requested.

Parameters:

t - the Throwable whose stacktrace should be printed

s - the PrintStream to print to

filtered - if true filter out uninteresting stack frames; if false print out all stack frames

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintStream ps)

Prints stacktrace of the given Throwable to to the given PrintStream filtering out certain stack frames if requested.

Parameters:

t - the Throwable whose stacktrace should be printed

s - the PrintStream to print to

outputConfig - a OutputConfiguration to configure text written to s

upToFrame - if not -1 (the default) print only stack frames up to this index (used internal)

fromFrame - if not -1 (the default) print only stack frames starting from thix index (used internal)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintStream ps,
                                   OutputConfiguration outputConfig)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintStream ps,
                                   OutputConfiguration outputConfig,
                                   int upToFrame)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintStream ps,
                                   OutputConfiguration outputConfig,
                                   int upToFrame,
                                   int fromFrame)

printStackTraceAsCause

public static void printStackTraceAsCause(java.lang.String cm,
                                          java.lang.Throwable t,
                                          java.io.PrintWriter pw,
                                          java.lang.StackTraceElement[] causedTrace,
                                          OutputConfiguration outputConfig)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintWriter pw)

Prints stacktrace of the given Throwable to to the given PrintWriter filtering out certain stack frames if requested.

Parameters:

t - the Throwable whose stacktrace should be printed

s - the PrintWriter to print to

outputConfig - a OutputConfiguration to configure text written to s

upToFrame - if not -1 (the default) print only stack frames up to this index (used internal)

fromFrame - if not -1 (the default) print only stack frames starting from thix index (used internal)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig,
                                   int upToFrame)

printStackTrace

public static void printStackTrace(java.lang.Throwable t,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig,
                                   int upToFrame,
                                   int fromFrame)

printStackTrace

public static void printStackTrace(java.lang.StackTraceElement[] stackTraceEls,
                                   java.io.PrintWriter pw)

Prints the given stacktrace to to the given PrintWriter filtering out certain stack frames if requested.

Parameters:

stacktrace - the stacktrace which should be printed

s - the PrintWriter to print to

outputConfig - a OutputConfiguration to configure text written to s

upToFrame - if not -1 (the default) print only stack frames up to this index (used internal)

fromFrame - if not -1 (the default) print only stack frames starting from thix index (used internal)

printStackTrace

public static void printStackTrace(java.lang.StackTraceElement[] stackTraceEls,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig)

printStackTrace

public static void printStackTrace(java.lang.StackTraceElement[] stackTraceEls,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig,
                                   int upToFrame)

printStackTrace

public static void printStackTrace(java.lang.StackTraceElement[] stackTraceEls,
                                   java.io.PrintWriter pw,
                                   OutputConfiguration outputConfig,
                                   int upToFrame,
                                   int fromFrame)

filterStackTrace

public static java.lang.Throwable filterStackTrace(java.lang.Throwable t)

Filters the stack trace of a Throwable and its causes using default filters.

This method removes stack frames that are typically irrelevant for debugging or logging purposes, such as frames from internal library classes. It processes the given Throwable and all its causes, applying the default filters to each stack trace.

Parameters:

t - The Throwable whose stack trace should be filtered. May be null.

Returns:

The filtered Throwable, or null if the input is null. This allows for convenient usage, such as log.error("Some problem", ThrowableTools.filterStackTrace(re)).

See Also:

de.ipcon.tools.StackTraceFilter.STANDARD_FILTERS

getStackTraceElement

public static java.lang.StackTraceElement getStackTraceElement(java.lang.Throwable t,
                                                               java.lang.String declaringClass,
                                                               java.lang.String methodName)

Helper method to extract a certain element/part of a stacktrace

Parameters:

t -

declaringClass -

methodName -

fileName - optional; e.g. leave filename empty when searching for specific class/method in stack trace

getStackTraceElement

public static java.lang.StackTraceElement getStackTraceElement(java.lang.Throwable t,
                                                               java.lang.String declaringClass,
                                                               java.lang.String methodName,
                                                               java.lang.String fileName)

filterAndDumpStackTrace

public static void filterAndDumpStackTrace(java.lang.String str)

Reads a stacktrace given as String and dumps it to STDOUT in filtered form. Mainly for debugging purposes.

Parameters:

str - the stacktrace as a String

getErrortext

public static java.lang.String getErrortext(java.lang.Exception ex)

Generates and returns a text consisting of the given message (if any) and a string dump of the exception stacktrace slightly formatted to be used for storing as error info text with objects or similar. Basically a slightly more fancy version of getStackTraceAsString().

getErrortext

public static java.lang.String getErrortext(java.lang.Exception ex,
                                            java.lang.String msg)