com.antelmann.util
Class Debug

java.lang.Object
  com.antelmann.util.Debug

public final class Debug
extends Object

provides globally accessible methods and variables for convenient debugging

Author:

Holger Antelmann

See Also:

Monitor

Nested Class Summary

static class

Debug.FileExceptionHandler can be used to conveniently write all exceptions to a file.

Field Summary

static Thread.UncaughtExceptionHandler	dialogExceptionHandler can be used to display a dialog for uncaught exceptions.
static boolean	enabled false by default
static MyFile	file a MyFile object that is initially null
static Logger	logger the logger is initialized as a plain empty logger
static Monitor	monitor monitor is initialized with new Monitor()
static Stopwatch	stopwatch initialized as non-running

Method Summary

static void	addSystemErrFile(File file, boolean append)
static void	addSystemOutFile(File file, boolean append)
static TimerTask	createMemoryLogTimer()
static void	dumpSettings() prints all settings (including all system properties and environment variables) to the console.
static void	dumpStack()
static String	getStackTraceAsString() excludes the call to this method and beyond in the stack trace
static boolean	printToFile(Throwable t, File file, boolean append) returns true only if operation was successfull
static File	printToTempFile(Throwable t) returns the name of the temp file the Throwable was written to or null if the write attempt was unsuccessful.
static void	say(Object txt) just for test debugging; prints the text along w/ the word debug on the console (to distinguish from standard System.out.println() in the source code)
static void	setSystemErr(File file, boolean append)
static void	setSystemOut(File file, boolean append)
static void	show(Component parent, Object message) displays a debug message in a modal dialog
static void	show(Object message) displays a debug message in a modal dialog
static void	showMemoryGauge() pops up a JMemoryGauge in a simple JMainFrame
static String	stackTraceAsString(Throwable t)
static String	stackTraceAsString(Throwable tw, Thread td)

Methods inherited from class java.lang.Object

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

Field Detail

dialogExceptionHandler

public static final Thread.UncaughtExceptionHandler dialogExceptionHandler

can be used to display a dialog for uncaught exceptions.

See Also:

Thread.setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler), Thread.setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)

monitor

public static final Monitor monitor

monitor is initialized with new Monitor()

enabled

public static volatile boolean enabled

false by default

logger

public static final Logger logger

the logger is initialized as a plain empty logger

stopwatch

public static final Stopwatch stopwatch

initialized as non-running

file

public static MyFile file

a MyFile object that is initially null

Method Detail

createMemoryLogTimer

public static TimerTask createMemoryLogTimer()

showMemoryGauge

public static void showMemoryGauge()

pops up a JMemoryGauge in a simple JMainFrame

See Also:

JMemoryGauge

show

public static void show(Object message)

displays a debug message in a modal dialog

show

public static void show(Component parent,
                        Object message)

displays a debug message in a modal dialog

stackTraceAsString

public static String stackTraceAsString(Throwable t)

stackTraceAsString

public static String stackTraceAsString(Throwable tw,
                                        Thread td)

printToTempFile

public static File printToTempFile(Throwable t)

returns the name of the temp file the Throwable was written to or null if the write attempt was unsuccessful.

printToFile

public static boolean printToFile(Throwable t,
                                  File file,
                                  boolean append)

returns true only if operation was successfull

dumpSettings

public static void dumpSettings()

prints all settings (including all system properties and environment variables) to the console. The output is sorted by property name. System variables may be overwritten by system properties may be overwritten by application settings in this map.

getStackTraceAsString

public static String getStackTraceAsString()

excludes the call to this method and beyond in the stack trace

dumpStack

public static void dumpStack()

addSystemErrFile

public static void addSystemErrFile(File file,
                                    boolean append)
                             throws FileNotFoundException

Throws:

FileNotFoundException

addSystemOutFile

public static void addSystemOutFile(File file,
                                    boolean append)
                             throws FileNotFoundException

Throws:

FileNotFoundException

setSystemErr

public static void setSystemErr(File file,
                                boolean append)
                         throws FileNotFoundException

Throws:

FileNotFoundException

setSystemOut

public static void setSystemOut(File file,
                                boolean append)
                         throws FileNotFoundException

Throws:

FileNotFoundException

say

public static void say(Object txt)

just for test debugging; prints the text along w/ the word debug on the console (to distinguish from standard System.out.println() in the source code)