org.ws4d.java.util

Class Log

java.lang.Object

org.ws4d.java.util.Log

public final class Log
extends java.lang.Object

Debug class provides logging mechanism and control over the output messages.
Use this instead of System.out.println().

To change the debug level and the message output, use setDebugLevel(int level).

e.g.
setDebugLevel(Debug.DEBUG_LEVEL_WARNING);

DEBUG_LEVEL_DEBUG = highest output level, every message shown.
DEBUG_LEVEL_INFO = show information, log, warn and error messages only.
DEBUG_LEVEL_LOG = show log, warn and error messages only.
DEBUG_LEVEL_WARN = show warn and error messages only.
DEBUG_LEVEL_ERROR = show error messages only.
DEBUG_LEVEL_NO_LOGGING = show nothing.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Marker	DEBUG_LAYER_APPLICATION Should be used to show application layer (device+service) debug messages
static org.slf4j.Marker	DEBUG_LAYER_COMMUNICATION Should be used to show communication layer debug messages.
static org.slf4j.Marker	DEBUG_LAYER_FRAMEWORK Should be used to show general framework debug messages.

Constructor Summary

Constructors

Constructor and Description
Log()

Method Summary

Modifier and Type	Method and Description
static void	debug(java.lang.String msg) Logs a debug message. Use this for debugging messages. The message is logged only when the current debug level is >= DEBUG_LEVEL_DEBUG.
static void	debug(java.lang.String msg, org.slf4j.Marker layer) Logs a debug message. Use this for debugging messages. The message is logged only when the current debug level is >= DEBUG_LEVEL_DEBUG.
static void	error(java.lang.String msg) Logs an error message. Use this for messages regarding critical errors. The message is logged only when the current debug level is >= DEBUG_LEVEL_ERROR.
static void	info(java.lang.String msg) Logs an info message. Use this for informational messages. The message is logged only when the current debug level is >= DEBUG_LEVEL_INFO.
static boolean	isDebug() Checks whether the current log level is at least debug.
static boolean	isError() Checks whether the current log level is at least error.
static boolean	isInfo() Checks whether the current log level is at least info.
static boolean	isWarn() Checks whether the current log level is at least warning.
static void	printStackTrace(java.lang.Throwable t) Prints stack trace, if debug level is "Error" or higher and logging of stack traces is on.
static void	warn(java.lang.String msg) Logs a warning message. Use this for messages about malfunctions which are not so severe to be treated as errors. The message is logged only when the current debug level is >= DEBUG_LEVEL_WARN.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_LAYER_FRAMEWORK

public static final org.slf4j.Marker DEBUG_LAYER_FRAMEWORK

Should be used to show general framework debug messages.

DEBUG_LAYER_APPLICATION

public static final org.slf4j.Marker DEBUG_LAYER_APPLICATION

Should be used to show application layer (device+service) debug messages

DEBUG_LAYER_COMMUNICATION

public static final org.slf4j.Marker DEBUG_LAYER_COMMUNICATION

Should be used to show communication layer debug messages.

Constructor Detail

Log

public Log()

Method Detail

isDebug

public static boolean isDebug()

Checks whether the current log level is at least debug.

Returns:

whether the current log level is at least debug or not

isInfo

public static boolean isInfo()

Checks whether the current log level is at least info.

Returns:

whether the current log level is at least info or not

isWarn

public static boolean isWarn()

Checks whether the current log level is at least warning.

Returns:

whether the current log level is at least warning or not

isError

public static boolean isError()

Checks whether the current log level is at least error.

Returns:

whether the current log level is at least error or not

debug

public static void debug(java.lang.String msg)

Logs a debug message.
Use this for debugging messages.
The message is logged only when the current debug level is >= DEBUG_LEVEL_DEBUG.

Parameters:

msg - the message to log.

debug

public static void debug(java.lang.String msg,
                         org.slf4j.Marker layer)

Logs a debug message.
Use this for debugging messages.
The message is logged only when the current debug level is >= DEBUG_LEVEL_DEBUG.

Parameters:

msg - the message to log.

layer - the debug layer to log the message to

info

public static void info(java.lang.String msg)

Logs an info message.
Use this for informational messages.
The message is logged only when the current debug level is >= DEBUG_LEVEL_INFO.

Parameters:

msg - the message to log.

error

public static void error(java.lang.String msg)

Logs an error message.
Use this for messages regarding critical errors.
The message is logged only when the current debug level is >= DEBUG_LEVEL_ERROR.

Parameters:

msg - the message to log.

warn

public static void warn(java.lang.String msg)

Logs a warning message.
Use this for messages about malfunctions which are not so severe to be treated as errors.
The message is logged only when the current debug level is >= DEBUG_LEVEL_WARN.

Parameters:

msg - the message to log.

printStackTrace

public static void printStackTrace(java.lang.Throwable t)

Prints stack trace, if debug level is "Error" or higher and logging of stack traces is on. Will be printed to error output if possible. Within CLDC environment log will be printed to System.err.

Parameters:

t - the throwable.