ariba.util.core
Interface DebugState

All Known Implementing Classes:

AWRequestContext, Deque, Parameters, PropertyTable

public interface DebugState

DebugState is used on conjunction with the ThreadDebugState class to print out information on the current application state when problems occur, or for general debugging.

See Also:

ThreadDebugState

Method Summary

java.lang.Object

debugState() Returns an object that will be toStringed when the debug information needs to be printed.

Method Detail

debugState

java.lang.Object debugState()

Returns an object that will be toStringed when the debug information needs to be printed. This method will only be called when the information is to be printed out - which will be rare. This method may safely be slow. It is also ok for the value that would be returned to change over time, even after the time that it is intially set in ThreadDebugState.

The most common implementation is to create a new Map and set key and value pairs of information in that Map which it will then return.

Returns:

an object that encapsulates the state of the current application. The toString() method of the returned object should be made safe even if the object that implements DebugState is being modified at the time. Exceptions from toString are tollerable in this case, but data corruption is not.

See Also:

ThreadDebugState.set(ariba.util.core.ThreadDebugKey, java.lang.Object)