info.pppc.base.log

Class Logging

java.lang.Object

info.pppc.base.log.Logging

public final class Logging
extends java.lang.Object

This class is responsible for logging. Instead using System.out.println this way lets the programmer turning off logging messages more easily. The logging distinguishes between several logging types. The java logging is not used because of the missing classes in J2ME-API.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	FILTER_EXCLUDE A list of packages or classes that should not be logged.
static java.lang.String[]	FILTER_INCLUDE A list of packages or classes that should be logged in any case.
static int	MAXIMUM_VERBOSITY Maximum verbosity is like normal verbosity but it also includes debug messages.
static int	MINIMUM_VERBOSITY Minimum verbosity disables all log messages.
static int	NORMAL_VERBOSITY Normal verbosity contains log and error messages.
static int	TIME_ABSOLUTE Denotes that a log message must contain an absolute time stamp.
static long	TIME_BASE The load time of the class used to calculate relative time stamps.
static int	TIME_DISABLED Denotes that a log message must not contain a time stamp.
static int	TIME_RELATIVE Denotes that a logged message must contain a relative time stamp.
static int	TIME_ZONE The time zone for absolute time stamps (UTC +1, Germany).

Constructor Summary

Constructors

Constructor and Description
Logging()

Method Summary

Methods

Modifier and Type	Method and Description
static void	debug(java.lang.Class location, java.lang.String message) Write a debug message to the specified output.
static void	debug(java.lang.String location, java.lang.String message) Write a debug message to the specified output.
static void	error(java.lang.Class location, java.lang.String message, java.lang.Throwable e) Writes an error message to the specified output.
static void	error(java.lang.String location, java.lang.String message, java.lang.Throwable e) Writes an error message to the specified output.
static int	getVerbosity() Returns the current verbosity level of the logger.
static void	log(java.lang.Class location, java.lang.String message) Writes a log message to the specified output.
static void	log(java.lang.String location, java.lang.String message) Writes a log message to the specified output.
static void	setOutput(java.io.PrintStream stream) Sets the output of the logging facility to the specified print stream.
static void	setTrace(boolean trace) Enables or disables traces of exceptions.
static void	setVerbosity(int level) Sets the verbosity level of the logger.
static java.lang.String	timestamp(long millis) Returns a pretty printed time stamp whose format depends on the time parameter of the logging class.

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_EXCLUDE

public static java.lang.String[] FILTER_EXCLUDE

A list of packages or classes that should not be logged. The comparison is done by a startsWith string comparison on the class name of the location class. Thus, "base", "pcom" will filter all classes whose name matches base* and pcom*. Note that the exclude filter does not exclude error messages these messages are logged always as long as the ERROR flag is set to true.

FILTER_INCLUDE

public static java.lang.String[] FILTER_INCLUDE

A list of packages or classes that should be logged in any case. The comparison is done by a startsWith string comparison. See the exclusion filter for details. Note that the inclusion filter superceeds the exclusion filter. This can be used to turn on logging in some bogus class or package during debugging.

MINIMUM_VERBOSITY

public static final int MINIMUM_VERBOSITY

Minimum verbosity disables all log messages.

See Also:

Constant Field Values

NORMAL_VERBOSITY

public static final int NORMAL_VERBOSITY

Normal verbosity contains log and error messages.

See Also:

Constant Field Values

MAXIMUM_VERBOSITY

public static final int MAXIMUM_VERBOSITY

Maximum verbosity is like normal verbosity but it also includes debug messages.

See Also:

Constant Field Values

TIME_DISABLED

public static final int TIME_DISABLED

Denotes that a log message must not contain a time stamp.

See Also:

Constant Field Values

TIME_ABSOLUTE

public static final int TIME_ABSOLUTE

Denotes that a log message must contain an absolute time stamp. The time stamp form is hour[0-23]:minute[0-59]:second[0-59]:millis[0-999].

See Also:

Constant Field Values

TIME_RELATIVE

public static final int TIME_RELATIVE

Denotes that a logged message must contain a relative time stamp. The time stamp form hour[>=0]:minute[0-59]:second[0-59]:millis[0-999]. The relative offset is the load time of the class.

See Also:

Constant Field Values

TIME_ZONE

public static final int TIME_ZONE

The time zone for absolute time stamps (UTC +1, Germany).

See Also:

Constant Field Values

TIME_BASE

public static final long TIME_BASE

The load time of the class used to calculate relative time stamps.

Constructor Detail

Logging

public Logging()

Method Detail

setVerbosity

public static void setVerbosity(int level)

Sets the verbosity level of the logger.

Parameters:

level - The must be one of the verbosity constants.

getVerbosity

public static int getVerbosity()

Returns the current verbosity level of the logger.

Returns:

The current verbosity level of the logger.

setTrace

public static void setTrace(boolean trace)

Enables or disables traces of exceptions. Warning: in most cases this feature should not be changed. Actually, this should only be disabled for demonstrations.

Parameters:

trace - True to enable tracing, false to disable.

setOutput

public static void setOutput(java.io.PrintStream stream)

Sets the output of the logging facility to the specified print stream.

Parameters:

stream - The stream to print to.

log

public static void log(java.lang.String location,
       java.lang.String message)

Writes a log message to the specified output. Should be used if messages are necessary in normal use (like system start or end).

Parameters:

location - The source of the message used for filtering.

message - The message to be logged.

log

public static void log(java.lang.Class location,
       java.lang.String message)

Writes a log message to the specified output. Should be used if messages are necessary in normal use (like system start or end).

Parameters:

location - The source of the message used for filtering.

message - The message to be logged.

error

public static void error(java.lang.String location,
         java.lang.String message,
         java.lang.Throwable e)

Writes an error message to the specified output. This method should be used instead of printStackTrace() in every try-catch block. Note that error messages are never filtered.

Parameters:

location - The source of the message.

message - The message to be logged.

e - The exception caused this message used for traces.

error

public static void error(java.lang.Class location,
         java.lang.String message,
         java.lang.Throwable e)

Writes an error message to the specified output. This method should be used instead of printStackTrace() in every try-catch block. Note that error messages are never filtered.

Parameters:

location - The source of the message.

message - The message to be logged.

e - The exception caused this message used for traces.

debug

public static void debug(java.lang.String location,
         java.lang.String message)

Write a debug message to the specified output. Use this method to state any important or unimportant messages to debug the system. The output of those messages should be toggled of while running the system outside the development area..

Parameters:

location - The source of the message used for filtering.

message - The message to be logged.

debug

public static void debug(java.lang.Class location,
         java.lang.String message)

Write a debug message to the specified output. Use this method to state any important or unimportant messages to debug the system. The output of those messages should be toggled of while running the system outside the development area.

Parameters:

location - The source of the message used for filtering.

message - The message to be logged.

timestamp

public static java.lang.String timestamp(long millis)

Returns a pretty printed time stamp whose format depends on the time parameter of the logging class.

Parameters:

millis - The milliseconds to pretty print.

Returns:

A pretty printed absolute or relative time stamp. If the time flag is set to disabled, this method will return an empty string.