|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--nl.justobjects.toolkit.sys.Code
Coding Standards support
Support for defensive programming
{ ... Code.assert(booleanExpression(),"Assert that expression evaluates true"); ... Code.assertEquals(objectA,objectB,"Assert equality"); Code.assertEquals(1,2,"Assert equality"); ... Code.debug("Debug message"); ... Code.debug("Debug message",exception,object); ... Code.warning("warning message"); ... Code.warning("warning message",exception); ... Code.notImplemented(); Code.fail("fatal error"); ... }The debug output can be controlled with java properties:
java [-DDEBUG [-DDEBUG_PATTERNS="MyClass,my.package"] \\ [-DDEBUG_OPTIONS=[S][W]] \\ [-DDEBUG_VERBOSE=n] ] \\ my.package.main
Field Summary | |
private static Code |
__instance
|
private static java.lang.String |
__lock
|
private static java.io.PrintWriter |
__out
|
private static java.io.StringWriter |
__stringWriter
Shared static instances, reduces object creation at expense of lock contention in multi threaded debugging |
private static java.lang.StringBuffer |
__writerBuffer
|
private boolean |
_debugOn
|
private java.util.Vector |
_debugPatterns
|
private java.util.Vector |
_debugTriggers
|
private java.lang.String |
_patterns
|
private boolean |
_suppressStack
|
private boolean |
_suppressWarnings
|
private java.lang.String |
_triggers
|
private java.util.Hashtable |
_triggerSet
|
private int |
_verbose
|
Constructor Summary | |
protected |
Code()
Construct shared instance that decodes the options setup environments properties. |
Method Summary | |
static void |
assertContains(java.lang.String string,
java.lang.String sub,
java.lang.String m)
Check assertion that a string is a substring of another. |
static void |
assertEquals(char o1,
char o2,
java.lang.String m)
Check assertion that o1==o2. |
static void |
assertEquals(double o1,
double o2,
java.lang.String m)
Check assertion that o1==o2. |
static void |
assertEquals(long o1,
long o2,
java.lang.String m)
Check assertion that o1==o2. |
static void |
assertEquals(java.lang.Object o1,
java.lang.Object o2,
java.lang.String m)
Check assertion that o1==o2. |
static void |
assertTrue(boolean b,
java.lang.String m)
Check assertion that a boolean is true. |
static boolean |
debug()
Get debug status for the current stack frame |
static void |
debug(java.lang.Object o)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3,
java.lang.Object o4)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3,
java.lang.Object o4,
java.lang.Object o5)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3,
java.lang.Object o4,
java.lang.Object o5,
java.lang.Object o6)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3,
java.lang.Object o4,
java.lang.Object o5,
java.lang.Object o6,
java.lang.Object o7)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Object o1,
java.lang.Object o2,
java.lang.Object o3,
java.lang.Object o4,
java.lang.Object o5,
java.lang.Object o6,
java.lang.Object o7,
java.lang.Object o8)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.String m)
Programming debugging output sent to the Log. |
static void |
debug(java.lang.String m,
java.lang.Throwable ex)
As debug(String) Dont rely on side-effects |
static void |
debug(java.lang.Throwable ex)
As debug(String) Dont rely on side-effects |
static void |
fail(java.lang.String m)
Programmer initiated fatal CodeException. |
static void |
fail(java.lang.String m,
java.lang.Throwable ex)
Programmer initiated fatal error. |
static void |
fail(java.lang.Throwable ex)
Programmer initiated fatal error. |
private static void |
formatObject(java.lang.StringBuffer buf,
java.lang.Object o)
|
private static java.lang.String |
formatThrowable(java.lang.String msg,
java.lang.Throwable ex)
|
static boolean |
getDebug()
Get the debug status |
static java.lang.String |
getDebugPatterns()
Get the debug patterns |
static java.lang.String |
getDebugTriggers()
Get the debug triggers |
static boolean |
getSuppressStack()
Get the stack suppression status |
static boolean |
getSuppressWarnings()
Get the warnings suppression status |
static int |
getVerbose()
Get the verbosity level |
static void |
ignore(java.lang.Throwable ex)
Ignore an exception |
static void |
initParamsFromApplet(java.applet.Applet appl)
Initialize default behaviour from applet parameters Look for applet parameters of the same name as the system properties used to config Code. |
private static Code |
instance()
|
private boolean |
isDebugOnFor(Frame frame)
|
static void |
main(java.lang.String[] args)
Main for Code test harness |
static void |
notImplemented()
Standard fatal error for a method not yet implemented |
static void |
setDebug(boolean debug)
Set if debugging is on or off |
static void |
setDebugPatterns(java.lang.String patterns)
Set debug patterns |
static void |
setDebugTriggers(java.lang.String triggers)
Set debug triggers |
static void |
setSuppressStack(boolean stack)
Suppress stack trace |
static void |
setSuppressWarnings(boolean warnings)
Set warning suppression |
static void |
setVerbose(int verbose)
Set verbosity level |
(package private) static void |
test()
Test Harness |
static void |
triggerOff(java.lang.String trigger)
|
static void |
triggerOn(java.lang.String trigger)
|
static boolean |
verbose()
Get verbosity level |
static boolean |
verbose(int v)
Get verbosity level |
static void |
warning(java.lang.String m)
Programmer initiated warning, intended to be viewed by technical not operational staff. |
static void |
warning(java.lang.String m,
java.lang.Throwable ex)
Programmer initiated warning, intended to be viewed by technical not operational staff. |
static void |
warning(java.lang.Throwable ex)
Programmer initiated warning, intended to be viewed by technical not operational staff. |
Methods inherited from class java.lang.Object |
|
Field Detail |
private static final java.lang.String __lock
private static Code __instance
private static java.io.StringWriter __stringWriter
private static java.lang.StringBuffer __writerBuffer
private static java.io.PrintWriter __out
private boolean _debugOn
private boolean _suppressStack
private boolean _suppressWarnings
private int _verbose
private java.util.Vector _debugPatterns
private java.util.Vector _debugTriggers
private java.lang.String _patterns
private java.lang.String _triggers
private java.util.Hashtable _triggerSet
Constructor Detail |
protected Code()
Method Detail |
private static Code instance()
public static void initParamsFromApplet(java.applet.Applet appl)
public static void setDebug(boolean debug)
debug
- public static boolean getDebug()
public static void setSuppressStack(boolean stack)
stack
- if true stacks are not producedpublic static boolean getSuppressStack()
public static void setSuppressWarnings(boolean warnings)
warnings
- Warnings suppress if this is true and debug is falsepublic static boolean getSuppressWarnings()
public static void setVerbose(int verbose)
verbose
- public static int getVerbose()
public static void setDebugPatterns(java.lang.String patterns)
patterns
- coma separated string of patternspublic static java.lang.String getDebugPatterns()
public static void setDebugTriggers(java.lang.String triggers)
triggers
- coma separated string of triggerspublic static java.lang.String getDebugTriggers()
public static void triggerOn(java.lang.String trigger)
public static void triggerOff(java.lang.String trigger)
public static void assertTrue(boolean b, java.lang.String m)
b
- The boolean to assert is truem
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void assertEquals(java.lang.Object o1, java.lang.Object o2, java.lang.String m)
o1
- The first object to checko2
- The first object to checkm
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void assertEquals(long o1, long o2, java.lang.String m)
o1
- The first long to checko2
- The first long to checkm
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void assertEquals(double o1, double o2, java.lang.String m)
o1
- The first double to checko2
- The first double to checkm
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void assertEquals(char o1, char o2, java.lang.String m)
o1
- The first char to checko2
- The first char to checkm
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void assertContains(java.lang.String string, java.lang.String sub, java.lang.String m)
string
- The stringsub
- The sub stringm
- Message to log if assertion failsCodeException
- Thrown if assertion failspublic static void warning(java.lang.String m)
m
- The message body of the warningpublic static void warning(java.lang.String m, java.lang.Throwable ex)
m
- The message body of the warningex
- A Throwable objectpublic static void warning(java.lang.Throwable ex)
ex
- A Throwable objectpublic static void fail(java.lang.String m)
m
- The message body to log with the fatal errorCodeException
- thrown to cause fatal errorpublic static void fail(java.lang.String m, java.lang.Throwable ex)
m
- The message body to log with the fatal errorex
- The Throwable to print the full stack trace ofCodeException
- thrown to cause fatal errorpublic static void fail(java.lang.Throwable ex)
ex
- The Throwable to print the full stack trace ofCodeException
- thrown to cause fatal errorpublic static void notImplemented()
public static boolean verbose()
public static boolean verbose(int v)
v
- verbosity level to check againstpublic static boolean debug()
public static void debug(java.lang.String m)
m
- The debug message to log.public static void debug(java.lang.String m, java.lang.Throwable ex)
m
- The debug message to log.ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Throwable ex)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4, java.lang.Object o5)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4, java.lang.Object o5, java.lang.Object o6)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4, java.lang.Object o5, java.lang.Object o6, java.lang.Object o7)
ex
- The Throwable to print the full stack trace ofpublic static void debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4, java.lang.Object o5, java.lang.Object o6, java.lang.Object o7, java.lang.Object o8)
ex
- The Throwable to print the full stack trace ofpublic static void ignore(java.lang.Throwable ex)
ex
- The Throwable to print the full stack trace ofprivate boolean isDebugOnFor(Frame frame)
private static void formatObject(java.lang.StringBuffer buf, java.lang.Object o)
private static java.lang.String formatThrowable(java.lang.String msg, java.lang.Throwable ex)
static void test()
public static void main(java.lang.String[] args)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |