Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mortbay >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mortbay.util
Class Code  

java.lang.Object
  org.mortbay.util.Code

---

public class Code

extends java.lang.Object

Coding Standards support. Support for defensive programming Coding defensively as follows:

 {
    ...
    Code.assertTrue(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:

• DEBUG - If set, debug output is enabled
• DEBUG_PATTERNS - If set to a comma separated list of strings, Then debug output is only produced from those classes whose fully qualified class name contains one of the strings as a substring.
• DEBUG_OPTIONS - A string of option character. 'W' - suppress warnings unless debug is on, 'S' suppress stack frame dumps
• DEBUG_VERBOSE - Set to an integer verbosity level for use in controlling debug verbosity (see verbose(int))

  Usage

   java [-DDEBUG [-DDEBUG_PATTERNS="MyClass,my.package"] \\
                 [-DDEBUG_OPTIONS=[S][W]] \\
                 [-DDEBUG_VERBOSE=n] ] \\
        my.package.main
   

  Version:

  $Id: Code.java,v 1.20 2003/06/27 19:23:41 hlavac Exp $

  ---

  Nested Class Summary
  static class	Code.LogMsg           Log Message Object passed to the Log by Code.
  private static class	Code.Singleton

   

  Field Summary
  private static java.lang.String[]	__nestedEx
  private static java.lang.Class[]	__noArgs
  private static java.io.PrintWriter	__printWriter
  private static StringBufferWriter	__stringBufferWriter           Shared static instances, reduces object creation at expense of lock contention in multi threaded debugging
  (package private)  boolean	_debugOn
  (package private)  java.util.Vector	_debugPatterns
  private  java.lang.String	_patterns
  private  boolean	_suppressStack
  private  boolean	_suppressWarnings
  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(int depth, java.lang.Object o)           Debug with frame depth.
  static void	debug(java.lang.Object o)           As debug(String) Do not rely on side-effects
  static void	debug(java.lang.Object o1, long l)           As debug(String) Do not rely on side-effects
  static void	debug(java.lang.Object o1, long l1, java.lang.Object o2, long l2)           As debug(String) Do not rely on side-effects
  static void	debug(java.lang.Object o1, java.lang.Object o2)           As debug(String) Do not rely on side-effects
  static void	debug(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3)           As debug(String) Do not 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) Do not 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) Do not 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) Do not 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) Do not 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) Do not 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) Do not rely on side-effects
  static void	debug(java.lang.Throwable ex)           As debug(String) Dont rely on side-effects
  private static void	expandThrowable(java.lang.Throwable ex)
  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)
  static boolean	getDebug()           Get the debug status.
  static java.lang.String	getDebugPatterns()           Get the debug patterns.
  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 Code	instance()
  private  boolean	isDebugOnFor(Frame frame)
  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	setSuppressStack(boolean stack)           Suppress stack trace.
  static void	setSuppressWarnings(boolean warnings)           Set warning suppression.
  static void	setVerbose(int verbose)           Set verbosity level.
  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

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

   

  Field Detail

  __noArgs

  private static final java.lang.Class[] __noArgs

  ---

  __nestedEx

  private static final java.lang.String[] __nestedEx

  ---

  __stringBufferWriter

  private static StringBufferWriter __stringBufferWriter

  Shared static instances, reduces object creation at expense of lock contention in multi threaded debugging

  ---

  __printWriter

  private static java.io.PrintWriter __printWriter

  ---

  _debugOn

  boolean _debugOn

  ---

  _suppressStack

  private boolean _suppressStack

  ---

  _suppressWarnings

  private boolean _suppressWarnings

  ---

  _verbose

  private int _verbose

  ---

  _debugPatterns

  java.util.Vector _debugPatterns

  ---

  _patterns

  private java.lang.String _patterns

  Constructor Detail

  Code

  protected Code()

  Construct shared instance that decodes the options setup environments properties.

  Method Detail

  instance

  public static Code instance()

  ---

  setDebug

  public static void setDebug(boolean debug)

  Set if debugging is on or off.

  ---

  getDebug

  public static boolean getDebug()

  Get the debug status.

  ---

  setSuppressStack

  public static void setSuppressStack(boolean stack)

  Suppress stack trace.

  ---

  getSuppressStack

  public static boolean getSuppressStack()

  Get the stack suppression status.

  ---

  setSuppressWarnings

  public static void setSuppressWarnings(boolean warnings)

  Set warning suppression.

  ---

  getSuppressWarnings

  public static boolean getSuppressWarnings()

  Get the warnings suppression status.

  ---

  setVerbose

  public static void setVerbose(int verbose)

  Set verbosity level.

  ---

  getVerbose

  public static int getVerbose()

  Get the verbosity level.

  ---

  setDebugPatterns

  public static void setDebugPatterns(java.lang.String patterns)

  Set debug patterns.

  ---

  getDebugPatterns

  public static java.lang.String getDebugPatterns()

  Get the debug patterns.

  ---

  assertTrue

  public static void assertTrue(boolean b,
                                java.lang.String m)

  Check assertion that a boolean is true. Logs and throws CodeException if the assertion fails.

  ---

  assertEquals

  public static void assertEquals(java.lang.Object o1,
                                  java.lang.Object o2,
                                  java.lang.String m)

  Check assertion that o1==o2. Logs and throws CodeException if the assertion fails.

  ---

  assertEquals

  public static void assertEquals(long o1,
                                  long o2,
                                  java.lang.String m)

  Check assertion that o1==o2. Logs and throws CodeException if the assertion fails.

  ---

  assertEquals

  public static void assertEquals(double o1,
                                  double o2,
                                  java.lang.String m)

  Check assertion that o1==o2. Logs and throws CodeException if the assertion fails.

  ---

  assertEquals

  public static void assertEquals(char o1,
                                  char o2,
                                  java.lang.String m)

  Check assertion that o1==o2. Logs and throws CodeException if the assertion fails.

  ---

  assertContains

  public 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. Logs and throws CodeException if the assertion fails.

  ---

  warning

  public static void warning(java.lang.String m)

  Programmer initiated warning, intended to be viewed by technical not operational staff.

  ---

  warning

  public static void warning(java.lang.String m,
                             java.lang.Throwable ex)

  Programmer initiated warning, intended to be viewed by technical not operational staff.

  ---

  warning

  public static void warning(java.lang.Throwable ex)

  Programmer initiated warning, intended to be viewed by technical not operational staff.

  ---

  fail

  public static void fail(java.lang.String m)

  Programmer initiated fatal CodeException.

  ---

  fail

  public static void fail(java.lang.String m,
                          java.lang.Throwable ex)

  Programmer initiated fatal error.

  ---

  fail

  public static void fail(java.lang.Throwable ex)

  Programmer initiated fatal error.

  ---

  notImplemented

  public static void notImplemented()

  Standard fatal error for a method not yet implemented.

  ---

  verbose

  public static boolean verbose()

  Get verbosity level.

  ---

  verbose

  public static boolean verbose(int v)

  Get verbosity level.

  ---

  debug

  public static boolean debug()

  Get debug status for the current stack frame.

  ---

  debug

  public static void debug(java.lang.String m)

  Programming debugging output sent to the Log. For debug output to be generated, the property DEBUG must be passed to the java VM. If the property DEBUG_PATTERN is set, it is used as a regular expression on the method, file and thread names to filter debug generation. Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.String m,
                           java.lang.Throwable ex)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Throwable ex)

  As debug(String) Dont rely on side-effects

  ---

  debug

  public static void debug(int depth,
                           java.lang.Object o)

  Debug with frame depth.

  ---

  debug

  public static void debug(java.lang.Object o)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Object o1,
                           java.lang.Object o2)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Object o1,
                           long l)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Object o1,
                           java.lang.Object o2,
                           java.lang.Object o3)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Object o1,
                           java.lang.Object o2,
                           java.lang.Object o3,
                           java.lang.Object o4)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public static void debug(java.lang.Object o1,
                           long l1,
                           java.lang.Object o2,
                           long l2)

  As debug(String) Do not rely on side-effects

  ---

  debug

  public 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) Do not rely on side-effects

  ---

  debug

  public 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) Do not rely on side-effects

  ---

  debug

  public 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) Do not rely on side-effects

  ---

  debug

  public 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) Do not rely on side-effects

  ---

  ignore

  public static void ignore(java.lang.Throwable ex)

  Ignore an exception.

  ---

  isDebugOnFor

  private boolean isDebugOnFor(Frame frame)

  ---

  formatObject

  private static void formatObject(java.lang.StringBuffer buf,
                                   java.lang.Object o)

  ---

  expandThrowable

  private static void expandThrowable(java.lang.Throwable ex)

  ---

  Overview  Package   Class  Use  Deprecated  Index
  Home >> All >> org >> mortbay >> [ util overview ]	PREV CLASS  NEXT CLASS
  SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

  ---