burlap.debugtools

Class DPrint

java.lang.Object

burlap.debugtools.DPrint

public class DPrint
extends java.lang.Object

A class for managing debug print statements. Different debug print statements can be associated with different debug ids and enabling or disabling print commands for that debug id can be performed from any class

Author:

James MacGlashan

Method Summary

Modifier and Type	Method and Description
static void	c(int c, java.lang.String s) A print command for the given debug code.
static void	cf(int c, java.lang.String s, java.lang.Object... args) A printf command for the given debug code.
static void	cl(int c, java.lang.String s) A print line command for the given debug code.
static boolean	mode(int c) Returns the print mode for a given debug code
static void	toggleCode(int c, boolean mode) Enables/disables print commands to the given debug code
static void	toggleUniversal(boolean mode) Specify whether previously unset debug codes will by default be allowed to print or not.
static void	u(java.lang.String s) A universal print whose behavior is determined by the universalPrint field
static void	uf(java.lang.String s, java.lang.Object... args) A universal printf whose behavior is determined by the universalPrint field
static void	ul(java.lang.String s) A universal print line whose behavior is determined by the universalPrint field

Methods inherited from class java.lang.Object

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

Method Detail

toggleUniversal

public static void toggleUniversal(boolean mode)

Specify whether previously unset debug codes will by default be allowed to print or not.

Parameters:

mode - whether to enable default printing or default suppression.

toggleCode

public static void toggleCode(int c,
                              boolean mode)

Enables/disables print commands to the given debug code

Parameters:

c - the print debug code to set

mode - true indicates that print calls to that code will print; false means that they will not

ul

public static void ul(java.lang.String s)

A universal print line whose behavior is determined by the universalPrint field

Parameters:

s - the string to print

u

public static void u(java.lang.String s)

A universal print whose behavior is determined by the universalPrint field

Parameters:

s - the string to print

uf

public static void uf(java.lang.String s,
                      java.lang.Object... args)

A universal printf whose behavior is determined by the universalPrint field

Parameters:

s - the format string

args - the arguments for the formatted string

cl

public static void cl(int c,
                      java.lang.String s)

A print line command for the given debug code. If that debug code is set to false, then the print will not occur.

Parameters:

c - the debug code under which printing should be performed

s - the string to print

c

public static void c(int c,
                     java.lang.String s)

A print command for the given debug code. If that debug code is set to false, then the print will not occur.

Parameters:

c - the debug code under which printing should be performed

s - the string to print

cf

public static void cf(int c,
                      java.lang.String s,
                      java.lang.Object... args)

A printf command for the given debug code. If that debug code is set to false, then the print will not occur.

Parameters:

c - the debug code under which printing should be performed

s - the format string

args - the arguments for the formatted string

mode

public static boolean mode(int c)

Returns the print mode for a given debug code

Parameters:

c - the code to query.

Returns:

true if printing to that debug code is allowed; false if it is not allowed.