de.carne.util.logging

Class Log

java.lang.Object

de.carne.util.logging.Log

public final class Log
extends java.lang.Object

Simple wrapper for JDK's Logger class to have a minimum level of abstraction and a clear level semantics.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Level	LEVEL_DEBUG Log level for debug messages.
static java.util.logging.Level	LEVEL_ERROR Log level for error messages.
static java.util.logging.Level	LEVEL_INFO Log level for info messages.
static java.util.logging.Level	LEVEL_NOTICE Log level for notice messages used to record fundamental application states and events.
static java.util.logging.Level	LEVEL_WARNING Log level for warning messages.

Constructor Summary

Constructors

Constructor and Description
Log(java.lang.Class<?> clazz) Construct Log.
Log(java.lang.Class<?> clazz, java.util.ResourceBundle bundle) Construct Log.

Method Summary

Modifier and Type	Method and Description
void	debug(java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a debug message.
void	debug(java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a debug message.
void	error(java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a error message.
void	error(java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a error message.
java.util.logging.Logger	getLogger() Get the underlying JDK Logger.
void	info(java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a info message.
void	info(java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a info message.
boolean	isDebugLoggable() Check whether debug log level is currently logged.
boolean	isInfoLoggable() Check whether info log level is currently logged.
boolean	isLoggable(java.util.logging.Level level) Check whether a log level is currently logged.
static java.lang.String	levelToString(java.util.logging.Level level) Get the level string.
void	log(java.util.logging.Level level, java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a message.
void	notice(java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a notice message.
void	notice(java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a notice message.
static java.util.logging.Level	snapLevel(java.util.logging.Level level) Map a level to the best matching standard level.
void	warning(java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a warning message.
void	warning(java.lang.Throwable thrown, java.util.ResourceBundle bundle, java.lang.String format, java.lang.Object... args) Log a warning message.

Methods inherited from class java.lang.Object

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

Field Detail

LEVEL_NOTICE

public static final java.util.logging.Level LEVEL_NOTICE

Log level for notice messages used to record fundamental application states and events.

LEVEL_ERROR

public static final java.util.logging.Level LEVEL_ERROR

Log level for error messages.

LEVEL_WARNING

public static final java.util.logging.Level LEVEL_WARNING

Log level for warning messages.

LEVEL_INFO

public static final java.util.logging.Level LEVEL_INFO

Log level for info messages.

LEVEL_DEBUG

public static final java.util.logging.Level LEVEL_DEBUG

Log level for debug messages.

Constructor Detail

Log

public Log(java.lang.Class<?> clazz)

Construct Log.

Parameters:

clazz - The class to derive the log name from.

Log

public Log(java.lang.Class<?> clazz,
           java.util.ResourceBundle bundle)

Construct Log.

Parameters:

clazz - The class to derive the log name from.

bundle - The (optional) ResourceBundle to use for message localization.

Method Detail

getLogger

public java.util.logging.Logger getLogger()

Get the underlying JDK Logger.

Returns:

The underlying JDK Logger.

isLoggable

public boolean isLoggable(java.util.logging.Level level)

Check whether a log level is currently logged.

Parameters:

level - The level to check.

Returns:

True, if the log level is currently logged.

log

public void log(java.util.logging.Level level,
                java.lang.Throwable thrown,
                java.util.ResourceBundle bundle,
                java.lang.String format,
                java.lang.Object... args)

Log a message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

level - The log level.

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

notice

public void notice(java.util.ResourceBundle bundle,
                   java.lang.String format,
                   java.lang.Object... args)

Log a notice message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

notice

public void notice(java.lang.Throwable thrown,
                   java.util.ResourceBundle bundle,
                   java.lang.String format,
                   java.lang.Object... args)

Log a notice message.

See MessageFormat.format for format options.

Parameters:

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

error

public void error(java.util.ResourceBundle bundle,
                  java.lang.String format,
                  java.lang.Object... args)

Log a error message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

error

public void error(java.lang.Throwable thrown,
                  java.util.ResourceBundle bundle,
                  java.lang.String format,
                  java.lang.Object... args)

Log a error message.

See MessageFormat.format for format options.

Parameters:

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

warning

public void warning(java.util.ResourceBundle bundle,
                    java.lang.String format,
                    java.lang.Object... args)

Log a warning message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

warning

public void warning(java.lang.Throwable thrown,
                    java.util.ResourceBundle bundle,
                    java.lang.String format,
                    java.lang.Object... args)

Log a warning message.

See MessageFormat.format for format options.

Parameters:

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

isInfoLoggable

public boolean isInfoLoggable()

Check whether info log level is currently logged.

Returns:

true, if info log level is currently logged.

info

public void info(java.util.ResourceBundle bundle,
                 java.lang.String format,
                 java.lang.Object... args)

Log a info message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

info

public void info(java.lang.Throwable thrown,
                 java.util.ResourceBundle bundle,
                 java.lang.String format,
                 java.lang.Object... args)

Log a info message.

See MessageFormat.format for format options.

Parameters:

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

isDebugLoggable

public boolean isDebugLoggable()

Check whether debug log level is currently logged.

Returns:

true, if debug log level is currently logged.

debug

public void debug(java.util.ResourceBundle bundle,
                  java.lang.String format,
                  java.lang.Object... args)

Log a debug message.

See MessageFormat.format(String, Object...) for format options.

Parameters:

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

debug

public void debug(java.lang.Throwable thrown,
                  java.util.ResourceBundle bundle,
                  java.lang.String format,
                  java.lang.Object... args)

Log a debug message.

See MessageFormat.format for format options.

Parameters:

thrown - The (optional) Throwable to log.

bundle - The (optional) ResourceBundle to use for message localization.

format - The log message.

args - The (optional) log message parameters.

levelToString

public static java.lang.String levelToString(java.util.logging.Level level)

Get the level string.

Parameters:

level - The level to get the string for.

Returns:

The level string.

snapLevel

public static java.util.logging.Level snapLevel(java.util.logging.Level level)

Map a level to the best matching standard level.

Parameters:

level - The level to map.

Returns:

The matching standard level.