com.physpics.tools.debug

Class DebugTools

java.lang.Object

com.physpics.tools.debug.DebugTools

public class DebugTools
extends java.lang.Object

Format and output debug messages The default destination is System.out. Output can be turned off with setStream(null). Multiple instances may be used for multiple contexts. Or the default instance may be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DebugTools.DebugFocus A KeyboardFocusManager that records the events it passes.
class	DebugTools.DebugStream Specialized class for writing debug text.
static class	DebugTools.DefaultLineWriter
static interface	DebugTools.LineWriter Superclass of objects that receive and process lines produced by DebugStream instances.
class	DebugTools.LoggingJFrame A subclass of JFrame that logs events going through processEvent.
class	DebugTools.MouseLoggingAdapter An adapter that handles mouse events and logs them before passing them on.

Field Summary

Fields

Modifier and Type	Field and Description
java.awt.KeyEventDispatcher	keyEventDispatcher tool for printing all keyboard events usage: KeyboardFocusManager.getCurrentKeyboardFocusManager() .addKeyEventDispatcher(keyEventDispatcher); remove with method removeKeyEventDispatcher
DebugTools.LineWriter	outDebug A LineWriter that sends the lines to System.out.
DebugTools.LineWriter	silentDebug A LineWriter that simply ignores its input.

Constructor Summary

Constructors

Constructor and Description
DebugTools() create a new debugging context.

Method Summary

Modifier and Type	Method and Description
java.lang.String	callers(boolean doself, int n) Returns a string identifying the call path to the client.
java.lang.String	callers(int n) Returns a string identifying the call path to the client.
static void	compareTwoFiles(java.lang.String fileA, java.lang.String fileB) Compare two files with diff and send result to stdout.
static void	compareTwoFiles(java.lang.String fileA, java.lang.String fileB, File dest) Compare two files with diff and send result to a File.
static void	compareTwoFiles(java.lang.String fileA, java.lang.String fileB, java.lang.ProcessBuilder.Redirect dest) Compare two files with diff and send result to a ProcessBuilder.Redirect.
PrintStream	createStddbg()
PrintStream	createStddbg(DebugTools.LineWriter wrtr)
PrintStream	createStddbg(java.lang.String charset, DebugTools.LineWriter wrtr)
static java.lang.String	deMax(int v)
static java.lang.String	errorcntstr(int errs) Format a number-of-errors value.
static DebugTools	getDefault()
PrintStream	getStddbg()
java.lang.String	getStddbgPrefix()
DebugTools.LineWriter	getStddbgWriter()
boolean	isFocusLogging()
boolean	isKeyLogging()
static java.lang.String	naturalSize(java.awt.Dimension dim)
void	printOnEDT(java.lang.String s) Utility to ensure that printing is done on the Event Dispatch Thread.
void	setFocusLogging(boolean turnOn) Turn on focus logging by replacing the current KeyboardFocusManager.
void	setKeyLogging(boolean turnOn) Turn on key logging by adding a local key event dispatcher to the KeybordFocusManager
void	setStddbgPrefix(java.lang.String pre)
void	setStddbgWriter(DebugTools.LineWriter newWriter)
static java.lang.String	sizeList(java.awt.Component vic) Produce a formatted description of the size information of a component.
void	traceContainerSize(java.awt.Component vic) Print size parameters for all ancestors of a component.
void	traceSize(java.awt.Component vic, java.lang.String indent) Print size parameters for a tree of components.

Methods inherited from class java.lang.Object

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

Field Detail

silentDebug

public DebugTools.LineWriter silentDebug

A LineWriter that simply ignores its input. Suitable argument for setStddbgWriter.

outDebug

public DebugTools.LineWriter outDebug

A LineWriter that sends the lines to System.out. Suitable argument for setStddbgWriter.

keyEventDispatcher

public java.awt.KeyEventDispatcher keyEventDispatcher

tool for printing all keyboard events usage: KeyboardFocusManager.getCurrentKeyboardFocusManager() .addKeyEventDispatcher(keyEventDispatcher); remove with method removeKeyEventDispatcher

Constructor Detail

DebugTools

public DebugTools()

create a new debugging context. Each context has its own stddbg.

Method Detail

getDefault

public static DebugTools getDefault()

Returns:

the default debugging context

printOnEDT

public void printOnEDT(java.lang.String s)

Utility to ensure that printing is done on the Event Dispatch Thread. Otherwise thread deadlock is possible if the main thread tries to print.

Parameters:

s - The string to print

getStddbg

public PrintStream getStddbg()

Returns:

a PrintStream for debug output. A new PrintStream is created if none exists.

createStddbg

public PrintStream createStddbg()

Returns:

a newly created PrintStream for debug output. A new PrintStream is created only if none exists or the existing PrintStream uses some named charset.

createStddbg

public PrintStream createStddbg(DebugTools.LineWriter wrtr)

Parameters:

wrtr - A LineWriter for processing each output line. If there is an existing stddbg with an empty charset name, its LineWriter will be replaced.

Returns:

a PrintStream for debug output. A new PrintStream is created only if none exists or the existing PrintStream uses some named charset.

createStddbg

public PrintStream createStddbg(java.lang.String charset,
                                DebugTools.LineWriter wrtr)
                         throws UnsupportedEncodingException

Parameters:

charset - Name of the charset to use. Suggested value: "UTF-8". May be an empty string to invoke the default charset.

wrtr - A LineWriter for processing each output line. May be null to specify the default.

Returns:

a newly created PrintStream for debug output. Any pre-existing stddbg is flushed; it is inaccessible from methods here, but it will continue to operate if used.

Throws:

UnsupportedEncodingException - If charset does not name a valid encoding.

getStddbgPrefix

public java.lang.String getStddbgPrefix()

Returns:

the debug print line prefix. If the current LineWriter is not DefaultLineWriter, value is null.

setStddbgPrefix

public void setStddbgPrefix(java.lang.String pre)

Parameters:

pre - new value for debug print line prefix. If the current stddbg is not using DefauiltLineWriter, this method has no effect.

setStddbgWriter

public void setStddbgWriter(DebugTools.LineWriter newWriter)

getStddbgWriter

public DebugTools.LineWriter getStddbgWriter()

isFocusLogging

public boolean isFocusLogging()

isKeyLogging

public boolean isKeyLogging()

setFocusLogging

public void setFocusLogging(boolean turnOn)

Turn on focus logging by replacing the current KeyboardFocusManager.

Parameters:

turnOn - If true the focus manager below will be installled.

setKeyLogging

public void setKeyLogging(boolean turnOn)

Turn on key logging by adding a local key event dispatcher to the KeybordFocusManager

Parameters:

turnOn - desired state of key logging

callers

public java.lang.String callers(int n)

Returns a string identifying the call path to the client. The client itself is omitted from the string.

Parameters:

n - the number of parents of the client to report

Returns:

a String in the form: call-point from call-point from call-point ... where a call-point is ClassName.MethodName[line-number]

callers

public java.lang.String callers(boolean doself,
                                int n)

Returns a string identifying the call path to the client.

Parameters:

doself - If true, the client is included in the trace back list. Usually this is not necessary; so false is preferable.

n - the number of parents of the client to report

Returns:

a String in the form: call-point from call-point from call-point ... where a call-point is ClassName.MethodName[line-number]

deMax

public static java.lang.String deMax(int v)

naturalSize

public static java.lang.String naturalSize(java.awt.Dimension dim)

sizeList

public static java.lang.String sizeList(java.awt.Component vic)

Produce a formatted description of the size information of a component. This includes the minimum, preferred, and maximum sizes. The string is in the form

    (min-w,pref-w,max-w)x(min-h,pref-h,max-h)  nat ... 

where nat ... is the natural size for each limit that has been artificially set. The natural size is given in the form (w, h).

Parameters:

vic - the Component to be probed.

Returns:

the formatted size information.

traceSize

public void traceSize(java.awt.Component vic,
                      java.lang.String indent)

Print size parameters for a tree of components.

Parameters:

vic - The topmost of the components

indent - A line prefix. On recursive calls, this value is augmented with four additional spaces.

traceContainerSize

public void traceContainerSize(java.awt.Component vic)

Print size parameters for all ancestors of a component.

Parameters:

vic - The bottommost of the components

compareTwoFiles

public static void compareTwoFiles(java.lang.String fileA,
                                   java.lang.String fileB)

Compare two files with diff and send result to stdout.

Parameters:

fileA - First file

fileB - Second file

compareTwoFiles

public static void compareTwoFiles(java.lang.String fileA,
                                   java.lang.String fileB,
                                   File dest)

Compare two files with diff and send result to a File.

Parameters:

fileA - First file

fileB - Second file

dest - where to send the output

compareTwoFiles

public static void compareTwoFiles(java.lang.String fileA,
                                   java.lang.String fileB,
                                   java.lang.ProcessBuilder.Redirect dest)

Compare two files with diff and send result to a ProcessBuilder.Redirect.

Parameters:

fileA - First file

fileB - Second file

dest - where to send the output

errorcntstr

public static java.lang.String errorcntstr(int errs)

Format a number-of-errors value. Result is one of "NO errors", "one error ***", or "nnn errors ***".

Parameters:

errs - The number to format.

Returns:

Formatted string as described above.