de.aristaflow.adept2.util

Class StackTraceTools

java.lang.Object

de.aristaflow.adept2.util.StackTraceTools

public final class StackTraceTools
extends java.lang.Object

Provides tools to manipulate stack traces (i.e. arrays of StackTraceElements.

Author:

Patrick Schmidt

Method Summary

Modifier and Type	Method and Description
static java.lang.StackTraceElement[]	headTrim(java.lang.StackTraceElement[] origStackTrace, java.lang.Class<?> cls) Removes all elements from the head of the stack trace that refer to the given class.
static java.lang.StackTraceElement[]	headTrim(java.lang.StackTraceElement[] stackTrace, int trim) Removes the given number of elements from the head (i.e. the top) of the given stack trace and returns the result in a new array.
static java.lang.StackTraceElement[]	join(java.lang.StackTraceElement[] headStackTrace, int tailTrimOfHead, java.lang.StackTraceElement[] tailStackTrace, int headTrimOfTail) Joins the two given stack traces, i.e. append the tail stack trace to the head stack trace, and returns the result in a new array.
static java.lang.StackTraceElement[]	join(java.lang.StackTraceElement[] headStackTrace, java.lang.StackTraceElement[] tailStackTrace) Joins the two given stack traces, i.e. append the tail stack trace to the head stack trace, and returns the result in a new array.
static void	printStackTrace() Prints the current stack trace to System.out.
static java.lang.String	stackTracesToString(java.lang.StackTraceElement[] trace) Returns the designated stack trace as string.
static java.lang.String	stackTraceToString(java.lang.Throwable throwable) Returns the output of Throwable.printStackTrace(PrintWriter) in a string.
static java.lang.StackTraceElement[]	tailTrim(java.lang.StackTraceElement[] stackTrace, int trim) Removes the given number of elements from the tail (i.e. the bottom) of the given stack trace and returns the result in a new array.

Methods inherited from class java.lang.Object

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

Method Detail

tailTrim

public static java.lang.StackTraceElement[] tailTrim(java.lang.StackTraceElement[] stackTrace,
                                                     int trim)

Removes the given number of elements from the tail (i.e. the bottom) of the given stack trace and returns the result in a new array.

Parameters:

stackTrace - the stack trace to be trimmed

trim - the number of elements to be trimmed from the stack trace's tail

Returns:

a new stack trace without the trimmed elements

headTrim

public static java.lang.StackTraceElement[] headTrim(java.lang.StackTraceElement[] stackTrace,
                                                     int trim)

Removes the given number of elements from the head (i.e. the top) of the given stack trace and returns the result in a new array.

Parameters:

stackTrace - the stack trace to be trimmed

trim - the number of elements to be trimmed from the stack trace's head

Returns:

a new stack trace without the trimmed elements

headTrim

public static java.lang.StackTraceElement[] headTrim(java.lang.StackTraceElement[] origStackTrace,
                                                     java.lang.Class<?> cls)

Removes all elements from the head of the stack trace that refer to the given class.

Parameters:

origStackTrace - the stack trace to be trimmed

cls - the class for which to remove all elements from the head of the stack trace

Returns:

a new stack trace without the trimmed elements

join

public static java.lang.StackTraceElement[] join(java.lang.StackTraceElement[] headStackTrace,
                                                 java.lang.StackTraceElement[] tailStackTrace)

Joins the two given stack traces, i.e. append the tail stack trace to the head stack trace, and returns the result in a new array.

Parameters:

headStackTrace - the stack trace to which the tail stack trace will be appended

tailStackTrace - the stack trace that will be appended to the head stack trace

Returns:

the joined stack traces

join

public static java.lang.StackTraceElement[] join(java.lang.StackTraceElement[] headStackTrace,
                                                 int tailTrimOfHead,
                                                 java.lang.StackTraceElement[] tailStackTrace,
                                                 int headTrimOfTail)

Joins the two given stack traces, i.e. append the tail stack trace to the head stack trace, and returns the result in a new array. While doing so, the tail of the head stack trace and the head of the tail stack trace will be trimmed by the given numbers of elements.

Parameters:

headStackTrace - the stack trace to which the tail stack trace will be appended

tailTrimOfHead - the number of elements to be trimmed from the trail of the head stack trace

tailStackTrace - the stack trace that will be appended to the head stack trace

headTrimOfTail - the number of elements to be trimmed from the head of the tail stack trace

Returns:

the joined stack traces

stackTraceToString

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

Returns the output of Throwable.printStackTrace(PrintWriter) in a string.

Parameters:

throwable - the throwable

Returns:

the output of Throwable.printStackTrace(PrintWriter) in a string

stackTracesToString

public static java.lang.String stackTracesToString(java.lang.StackTraceElement[] trace)

Returns the designated stack trace as string.

Parameters:

trace - The stack trace to be transformed to a string.

Returns:

The designated stack trace as string.

printStackTrace

public static void printStackTrace()

Prints the current stack trace to System.out. This method is only useful for debugging purposes.