com.diffplug.common.base

Class StackDumper

java.lang.Object

com.diffplug.common.base.StackDumper

public class StackDumper
extends Object

Utility methods for dumping the stack - arbitrarily or at specific trigger points (such as when a certain string prints to console).

If someone is printing "junk" to the console and you can't figure out why, try StackDumper.dumpWhenSysOutContains("junk").

Constructor Summary

Constructors

Constructor and Description
StackDumper()

Method Summary

Modifier and Type	Method and Description
static List<StackTraceElement>	captureStackBelow(Class<?>... clazzes) Captures all of the current stack which is below the given classes.
static void	dump(String message) Dumps the current stack to the system error console.
static void	dump(String message, int stackLimit, String... classPrefixesToExclude) Dumps the first stackLimit frames of the current stack to the system error console, excluding traces from classPrefixesToExclude.
static void	dump(String message, List<StackTraceElement> stack) Dumps the given message and stack to the system error console.
static void	dump(String message, StackTraceElement[] stackTrace) Dumps the given message and stack to the system error console.
static void	dump(String message, Throwable exception) Dumps the given message and exception stack to the system error console
static void	dumpWhenSysErrContains(String trigger) Dumps a stack trace anytime trigger string is printed to System.err.
static void	dumpWhenSysOutContains(String trigger) Dumps a stack trace anytime the trigger string is printed to System.out.
static PrintStream	wrapAndDumpWhenContains(PrintStream source, String trigger) Returns a PrintStream which will redirect all of its output to the source PrintStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

StackDumper

public StackDumper()

Method Detail

dump

public static void dump(String message,
                        List<StackTraceElement> stack)

Dumps the given message and stack to the system error console.

dump

public static void dump(String message,
                        StackTraceElement[] stackTrace)

Dumps the given message and stack to the system error console.

dump

public static void dump(String message,
                        Throwable exception)

Dumps the given message and exception stack to the system error console

dump

public static void dump(String message)

Dumps the current stack to the system error console.

dump

public static void dump(String message,
                        int stackLimit,
                        String... classPrefixesToExclude)

Dumps the first stackLimit frames of the current stack to the system error console, excluding traces from classPrefixesToExclude.

dumpWhenSysOutContains

public static void dumpWhenSysOutContains(String trigger)

Dumps a stack trace anytime the trigger string is printed to System.out.

dumpWhenSysErrContains

public static void dumpWhenSysErrContains(String trigger)

Dumps a stack trace anytime trigger string is printed to System.err.

wrapAndDumpWhenContains

public static PrintStream wrapAndDumpWhenContains(PrintStream source,
                                                  String trigger)

Returns a PrintStream which will redirect all of its output to the source PrintStream. If the trigger string is passed through the wrapped PrintStream, then it will dump the stack trace of the call that printed the trigger.

Parameters:

source - the returned PrintStream will delegate to this stream

trigger - the string which triggers a stack dump

Returns:

a PrintStream with the above properties

captureStackBelow

public static List<StackTraceElement> captureStackBelow(Class<?>... clazzes)

Captures all of the current stack which is below the given classes.