| java.lang.Object
 org.apache.derby.shared.common.sanity.SanityManager
All known Subclasses: org.apache.derby.iapi.services.sanity.SanityManager,
| SanityManager | | public class SanityManager (Code) | | 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: org.apache.derby.iapi.services.sanity.AssertFailure |
| Field Summary | |
| final public static 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. | | final public static boolean | DEBUG
| | final public static String | DEBUGDEBUG
|
| Method Summary | |
| final public static void | ASSERT(boolean mustBeTrue)
ASSERT checks the condition, and if it is
false, throws AssertFailure. | | final public static void | ASSERT(boolean mustBeTrue, String msgIfFail)
ASSERT checks the condition, and if it is
false, throws AssertFailure. | | final public static 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. | | final public static void | DEBUG_ALL_OFF()
This can be used to have the SanityManager return FALSE
for any DEBUG_ON check. | | final public static void | DEBUG_ALL_ON()
This can be used to have the SanityManager return TRUE
for any DEBUG_ON check. | | final public static void | DEBUG_CLEAR(String flag)
Set the named debug flag to false. | | final public static 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. | | 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. | | final public static void | DEBUG_SET(String flag)
Set the named debug flag to true. | | public static java.io.PrintWriter | GET_DEBUG_STREAM()
| | public static void | NOTREACHED()
| | public static void | SET_DEBUG_STREAM(java.io.PrintWriter pw)
| | final public static void | THROWASSERT(String msgIfFail)
THROWASSERT throws AssertFailure. | | final public static void | THROWASSERT(String msg, Throwable t)
THROWASSERT throws AssertFailure. | | final public static void | THROWASSERT(Throwable t)
THROWASSERT throws AssertFailure. | | public static void | showTrace(Throwable t)
|
| ASSERT | | final public static boolean ASSERT(Code) | | 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.
|
| DEBUG | | final public static boolean DEBUG(Code) | | |
| DEBUG | | final public static void DEBUG(String flag, String message)(Code) | | 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_ALL_OFF | | final public static void DEBUG_ALL_OFF()(Code) | | 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.
|
| DEBUG_ALL_ON | | final public static void DEBUG_ALL_ON()(Code) | | 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_CLEAR | | final public static void DEBUG_CLEAR(String flag)(Code) | | 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_ON | | final public static boolean DEBUG_ON(String flag)(Code) | | 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.
true if the flag has been set to "true"; falseif the flag is not set, or is set to something other than "true". |
| DEBUG_PRINT | | public static void DEBUG_PRINT(String flag, String message)(Code) | | 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.
|
| DEBUG_SET | | final public static void DEBUG_SET(String flag)(Code) | | 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 |
| NOTREACHED | | public static void NOTREACHED()(Code) | | |
| THROWASSERT | | final public static void THROWASSERT(String msgIfFail)(Code) | | 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: org.apache.derby.iapi.services.sanity.AssertFailure |
| THROWASSERT | | final public static void THROWASSERT(String msg, Throwable t)(Code) | | 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
Parameters:
t - exception to print with the assertion
See Also: org.apache.derby.iapi.services.sanity.AssertFailure |
|
|