org.ka2ddo.util

Class DebugCtl

java.lang.Object

org.ka2ddo.util.DebugCtl

public class DebugCtl
extends java.lang.Object

This class manages the debug controls for the application, independent of how the controls are set by any user interface. As such, code wanting to test the debug controls to decide whether to output debug data can do so without being locked to a particular application.

Since:

PROVIDER_API_VERSION == 22

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DebugCtl.DbgListener Implementors of this interface, if registered with the addDbgListener(DbgListener, String, String) method, can be informed of dynamic changes in the debug flags.

Method Summary

Modifier and Type	Method and Description
static void	addDbgListener(DebugCtl.DbgListener l, java.lang.String categoryName, java.lang.String tagsToDisplayName) Register a listener for the specified categories of debug events.
static java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getCategoryCodesAndTagNames() Get the list of known dynamically modifiable debug categories and their tags for locale-specific descriptions.
static java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>>	getCategorySettings() Get the list of known dynamically modifiable debug categories and their tags for locale-specific descriptions.
static java.lang.String	getCategoryTag(java.lang.String category) Get the localization tag name for a description of the category.
static boolean	isDebug() Indicate if debug messages should be printed out.
static boolean	isDebug(java.lang.String categoryName) Indicate if a specific category of debug messages should be printed out.
static boolean	isDebugOnly(java.lang.String categoryName) Indicate if a specific category of debug messages should be printed out.
static void	removeDbgListener(DebugCtl.DbgListener l, java.lang.String... categoryNames) Unregister a listener for the specified categories of debug events.
static void	setDebug(java.lang.String categoryName, boolean setting) Specify if a specific category of debug messages should be printed out.

Methods inherited from class java.lang.Object

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

Method Detail

setDebug

public static void setDebug(java.lang.String categoryName,
                            boolean setting)

Specify if a specific category of debug messages should be printed out.

Parameters:

categoryName - String name of category to enable debug logging for

setting - boolean true or false to enable or disable debugging this category

isDebug

public static boolean isDebug()

Indicate if debug messages should be printed out.

Returns:

boolean true if debug messages should be printed

isDebug

public static boolean isDebug(java.lang.String categoryName)

Indicate if a specific category of debug messages should be printed out.

Parameters:

categoryName - String name of category to enable debug logging for

Returns:

boolean true if the named category of debug messages should be printed

isDebugOnly

public static boolean isDebugOnly(java.lang.String categoryName)

Indicate if a specific category of debug messages should be printed out.

Parameters:

categoryName - String name of category to enable debug logging for

Returns:

boolean true if the named category of debug messages should be printed

addDbgListener

public static void addDbgListener(DebugCtl.DbgListener l,
                                  java.lang.String categoryName,
                                  java.lang.String tagsToDisplayName)

Register a listener for the specified categories of debug events. If registered for the "all" category, such listeners will be informed of all debug changes and given the name of the category actually changed.

Parameters:

l - DbgListener to register (or null to just register a type and description)

categoryName - String names of debug categories; null implies "all"

tagsToDisplayName - String tag name for displaying the categories for dynamic debug level switching from the UI

removeDbgListener

public static void removeDbgListener(DebugCtl.DbgListener l,
                                     java.lang.String... categoryNames)

Unregister a listener for the specified categories of debug events.

Parameters:

l - DbgListener to unregister

categoryNames - array of String names of debug categories; zero-length implies an array of "all"

getCategoryCodesAndTagNames

public static java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getCategoryCodesAndTagNames()

Get the list of known dynamically modifiable debug categories and their tags for locale-specific descriptions.

Returns:

read-only Set of Map.Entry of category ID to resource tag names

getCategorySettings

public static java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> getCategorySettings()

Get the list of known dynamically modifiable debug categories and their tags for locale-specific descriptions.

Returns:

read-only Set of Map.Entry of category ID to resource tag names

getCategoryTag

public static java.lang.String getCategoryTag(java.lang.String category)

Get the localization tag name for a description of the category.

Parameters:

category - String category name

Returns:

String tag for looking up localized description in ResourceBundles, or null if no known tag