Package com.helger.commons.lang

Class StackTraceHelper

java.lang.Object

com.helger.commons.lang.StackTraceHelper

@Immutable
public final class StackTraceHelper
extends Object

This class contains utility methods for handling stack traces.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_LINE_SEPARATOR	the separator used to separate different lines of a stack

Method Summary

Modifier and Type	Method	Description
static void	appendStackToString(StringBuilder aSB, StackTraceElement[] aStackTraceElements)
static void	appendStackToString(StringBuilder aSB, StackTraceElement[] aStackTraceElements, String sLineSeparator)
static boolean	containsUnitTestElement(StackTraceElement[] aStackTrace)	Check if the passed stack trace array contains a unit test element.
static boolean	containsUnitTestElement(Throwable t)	Check if the passed stack trace array contains a unit test element.
static String	getCurrentThreadStackAsString()
static String	getStackAsString(StackTraceElement[] aStackTraceElements)
static String	getStackAsString(StackTraceElement[] aStackTraceElements, boolean bOmitCommonStackTraceElements)
static String	getStackAsString(StackTraceElement[] aStackTraceElements, boolean bOmitCommonStackTraceElements, String sLineSeparator)
static String	getStackAsString(Thread aThread)
static String	getStackAsString(Thread aThread, boolean bOmitCommonStackTraceElements)
static String	getStackAsString(Thread aThread, boolean bOmitCommonStackTraceElements, String sLineSeparator)
static String	getStackAsString(Throwable t)	Get the stack trace of a throwable as string.
static String	getStackAsString(Throwable t, boolean bOmitCommonStackTraceElements)	Get the stack trace of a throwable as string.
static String	getStackAsString(Throwable t, boolean bOmitCommonStackTraceElements, String sLineSeparator)	Get the stack trace of a throwable as string.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LINE_SEPARATOR

public static final String DEFAULT_LINE_SEPARATOR

the separator used to separate different lines of a stack

See Also:

Constant Field Values

Method Detail

appendStackToString

public static void appendStackToString(@Nonnull
                                       StringBuilder aSB,
                                       @Nonnull
                                       StackTraceElement[] aStackTraceElements)

appendStackToString

public static void appendStackToString(@Nonnull
                                       StringBuilder aSB,
                                       @Nonnull
                                       StackTraceElement[] aStackTraceElements,
                                       @Nonnull
                                       String sLineSeparator)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      StackTraceElement[] aStackTraceElements,
                                      boolean bOmitCommonStackTraceElements)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      StackTraceElement[] aStackTraceElements,
                                      boolean bOmitCommonStackTraceElements,
                                      @Nonnull
                                      String sLineSeparator)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      StackTraceElement[] aStackTraceElements)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      Thread aThread)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      Thread aThread,
                                      boolean bOmitCommonStackTraceElements)

getStackAsString

@Nonnull
public static String getStackAsString(@Nonnull
                                      Thread aThread,
                                      boolean bOmitCommonStackTraceElements,
                                      @Nonnull
                                      String sLineSeparator)

getCurrentThreadStackAsString

@Nonnull
public static String getCurrentThreadStackAsString()

getStackAsString

@Nonnull
public static String getStackAsString(@Nullable
                                      Throwable t)

Get the stack trace of a throwable as string.

Parameters:

t - The throwable to be converted. May be null.

Returns:

the stack trace as newline separated string. If the passed Throwable is null an empty string is returned.

getStackAsString

@Nonnull
public static String getStackAsString(@Nullable
                                      Throwable t,
                                      boolean bOmitCommonStackTraceElements)

Get the stack trace of a throwable as string.

Parameters:

t - The throwable to be converted. May be null.

bOmitCommonStackTraceElements - If true the stack trace is cut after certain class names occurring. If false the complete stack trace is returned.

Returns:

the stack trace as newline separated string. If the passed Throwable is null an empty string is returned.

getStackAsString

@Nonnull
public static String getStackAsString(@Nullable
                                      Throwable t,
                                      boolean bOmitCommonStackTraceElements,
                                      @Nonnull
                                      String sLineSeparator)

Get the stack trace of a throwable as string.

Parameters:

t - The throwable to be converted. May be null.

bOmitCommonStackTraceElements - If true the stack trace is cut after certain class names occurring. If false the complete stack trace is returned.

sLineSeparator - The line separator to use. May not be null.

Returns:

the stack trace as newline separated string. If the passed Throwable is null an empty string is returned.

Since:

9.3.6

containsUnitTestElement

public static boolean containsUnitTestElement(@Nullable
                                              Throwable t)

Check if the passed stack trace array contains a unit test element. Known unit test frameworks are JUnit and TestNG.

Parameters:

t - The Throwable whose stack trace should be scanned for unit test classes. May be null.

Returns:

true if at least one stack trace element is from a known unit test framework.

containsUnitTestElement

public static boolean containsUnitTestElement(@Nullable
                                              StackTraceElement[] aStackTrace)

Check if the passed stack trace array contains a unit test element. Known unit test frameworks are JUnit and TestNG.

Parameters:

aStackTrace - The stack trace array to be scanned. May be null.

Returns:

true if at least one stack trace element is from a known unit test framework.