com.togethersoft.openapi.util.diagnostic
Interface Diagnostic


public interface Diagnostic

This interface represents object responsible for diagnostic messages
handling. Diagnostic messages can be grouped by categories and for each
particular group one of three trace and assertion modes can be set.

Author:
TogetherSoft
Since: 5.5
See Also: DiagnosticMode

Method Summary
 booleanassert(String category, boolean condition, String message)
          Traces message according to mode set for category
if condition fails.
 intgetAssertMode(String category)
           
 intgetTraceMode(String category)
           
 booleanisEnabled()
           
 voidsetAssertMode(String category, int mode)
          Sets assertion mode for the category
 voidsetTraceMode(String category, int mode)
          Sets trace mode for the category
 voidtrace(String category, String message)
          Traces message according to mode set for category
 voidtrace(String category, Throwable exception)
          Traces exception according to mode set for category

Method Detail

assert

public boolean assert(String category, boolean condition, String message)
Traces message according to mode set for category
if condition fails.

getAssertMode

public int getAssertMode(String category)
Returns: Assertion mode for the given category
See Also:
DiagnosticMode

getTraceMode

public int getTraceMode(String category)
Returns: Trace mode for the given category
See Also:
DiagnosticMode

isEnabled

public boolean isEnabled()
Returns: true if diagnostic messages are enabled by
the configuration

setAssertMode

public void setAssertMode(String category, int mode)
Sets assertion mode for the category
See Also:
DiagnosticMode

setTraceMode

public void setTraceMode(String category, int mode)
Sets trace mode for the category
See Also:
DiagnosticMode

trace

public void trace(String category, String message)
Traces message according to mode set for category

trace

public void trace(String category, Throwable exception)
Traces exception according to mode set for category