Class SanityManager

java.lang.Object
org.apache.derby.shared.common.sanity.SanityManager

public class SanityManager extends Object
The SanityService provides assertion checking and debug control.

Assertions and debug checks can only be used for testing conditions that might occur in development code but not in production code. They are compiled out of production code.

Uses of assertions should not add AssertFailure catches or throws clauses; AssertFailure is under RuntimeException in the java exception hierarchy. Our outermost system block will bring the system down when it detects an assertion failure.

In addition to ASSERTs in code, classes can choose to implement an isConsistent method that would be used by ASSERTs, UnitTests, and any other code wanting to check the consistency of an object.

Assertions are meant to be used to verify the state of the system and bring the system down if the state is not correct. Debug checks are meant to display internal information about a running system.

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static boolean
     
    private static boolean
    AllDebugOn and AllDebugOff override individual flags
    static final boolean
    The build tool may be configured to alter this source file to reset the static final variables so that assertion and debug checks can be compiled out of the code.
    static final boolean
     
    static final String
     
    private static Hashtable<String,Boolean>
    DebugFlags holds the values of all debug flags in the configuration file.
    private static PrintWriter
    debugStream holds a pointer to the debug stream for writing out debug messages.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static final void
    ASSERT(boolean mustBeTrue)
    ASSERT checks the condition, and if it is false, throws AssertFailure.
    static final void
    ASSERT(boolean mustBeTrue, String msgIfFail)
    ASSERT checks the condition, and if it is false, throws AssertFailure.
    static final void
    DEBUG(String flag, String message)
    The DEBUG calls provide the ability to print information or perform actions based on whether a debug flag is set or not.
    static final void
    This can be used to have the SanityManager return FALSE for any DEBUG_ON check.
    static final void
    This can be used to have the SanityManager return TRUE for any DEBUG_ON check.
    static final void
    Set the named debug flag to false.
    static final boolean
    This can be called directly if you want to control what is done once the debug flag has been verified -- for example, if you are calling a routine that prints to the trace stream directly rather than returning a string to be printed, or if you want to perform more (or fewer!)
    static void
    DEBUG_PRINT(String flag, String message)
    The DEBUG_PRINT calls provides a convenient way to print debug information to the db2j.LOG file, The message includes a header
    static final void
    Set the named debug flag to true.
     
    static void
     
    static void
     
    static void
     
    private static void
     
    static final void
    THROWASSERT(String msgIfFail)
    THROWASSERT throws AssertFailure.
    static final void
    THROWASSERT throws AssertFailure.
    static final void
    THROWASSERT throws AssertFailure.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • ASSERT

      public static final boolean ASSERT
      The build tool may be configured to alter this source file to reset the static final variables so that assertion and debug checks can be compiled out of the code.
      See Also:
    • DEBUG

      public static final boolean DEBUG
      See Also:
    • DEBUGDEBUG

      public static final String DEBUGDEBUG
      See Also:
    • debugStream

      private static PrintWriter debugStream
      debugStream holds a pointer to the debug stream for writing out debug messages. It is cached at the first debug write request.
    • DebugFlags

      private static Hashtable<String,Boolean> DebugFlags
      DebugFlags holds the values of all debug flags in the configuration file.
    • AllDebugOn

      private static boolean AllDebugOn
      AllDebugOn and AllDebugOff override individual flags
    • AllDebugOff

      private static boolean AllDebugOff
  • Constructor Details

    • SanityManager

      public SanityManager()
  • Method Details

    • ASSERT

      public static final void ASSERT(boolean mustBeTrue)
      ASSERT checks the condition, and if it is false, throws AssertFailure. A message about the assertion failing is printed.

      See Also:
    • ASSERT

      public static final void ASSERT(boolean mustBeTrue, String msgIfFail)
      ASSERT checks the condition, and if it is false, throws AssertFailure. The message will be printed and included in the assertion.

      See Also:
    • THROWASSERT

      public static final void THROWASSERT(String msgIfFail)
      THROWASSERT throws AssertFailure. This is used in cases where the caller has already detected the assertion failure (such as in the default case of a switch). This method should be used, rather than throwing AssertFailure directly, to allow us to centralize all sanity checking. The message argument will be printed and included in the assertion.

      Parameters:
      msgIfFail - message to print with the assertion
      See Also:
    • THROWASSERT

      public static final void THROWASSERT(String msg, Throwable t)
      THROWASSERT throws AssertFailure. This flavor will print the stack associated with the exception. The message argument will be printed and included in the assertion.

      Parameters:
      msg - message to print with the assertion
      t - exception to print with the assertion
      See Also:
    • THROWASSERT

      public static final void THROWASSERT(Throwable t)
      THROWASSERT throws AssertFailure. This flavor will print the stack associated with the exception.

      Parameters:
      t - exception to print with the assertion
      See Also:
    • DEBUG

      public static final void DEBUG(String flag, String message)
      The DEBUG calls provide the ability to print information or perform actions based on whether a debug flag is set or not. debug flags are set in configurations and picked up by the sanity manager when the monitor finds them (see CONFIG below).

      The message is output to the trace stream, so it ends up in db2j.LOG. It will include a header line of DEBUG OUTPUT: before the message.

      If the debugStream stream cannot be found, the message is printed to System.out.

    • DEBUG_ON

      public static final boolean DEBUG_ON(String flag)
      This can be called directly if you want to control what is done once the debug flag has been verified -- for example, if you are calling a routine that prints to the trace stream directly rather than returning a string to be printed, or if you want to perform more (or fewer!)

      Calls to this method should be surrounded with if (SanityManager.DEBUG) { } so that they can be compiled out completely.

      Returns:
      true if the flag has been set to "true"; false if the flag is not set, or is set to something other than "true".
    • DEBUG_SET

      public static final void DEBUG_SET(String flag)
      Set the named debug flag to true.

      Calls to this method should be surrounded with if (SanityManager.DEBUG) { } so that they can be compiled out completely.

      Parameters:
      flag - The name of the debug flag to set to true
    • DEBUG_CLEAR

      public static final void DEBUG_CLEAR(String flag)
      Set the named debug flag to false.

      Calls to this method should be surrounded with if (SanityManager.DEBUG) { } so that they can be compiled out completely.

      Parameters:
      flag - The name of the debug flag to set to false
    • DEBUG_ALL_ON

      public static final void DEBUG_ALL_ON()
      This can be used to have the SanityManager return TRUE for any DEBUG_ON check. DEBUG_CLEAR of an individual flag will appear to have no effect.
    • DEBUG_ALL_OFF

      public static final void DEBUG_ALL_OFF()
      This can be used to have the SanityManager return FALSE for any DEBUG_ON check. DEBUG_SET of an individual flag will appear to have no effect.
    • SET_DEBUG_STREAM

      public static void SET_DEBUG_STREAM(PrintWriter pw)
    • GET_DEBUG_STREAM

      public static PrintWriter GET_DEBUG_STREAM()
    • showTrace

      private static void showTrace(AssertFailure af)
    • showTrace

      public static void showTrace(Throwable t)
    • DEBUG_PRINT

      public static void DEBUG_PRINT(String flag, String message)
      The DEBUG_PRINT calls provides a convenient way to print debug information to the db2j.LOG file, The message includes a header

      DEBUG OUTPUT: before the message

      If the debugStream stream cannot be found, the message is printed to System.out.

    • NOTREACHED

      public static void NOTREACHED()