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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String msg, java.lang.Object... parameters) Log debug message.
void	debug(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log debug message.
void	error(java.lang.String msg, java.lang.Object... parameters) Log error message.
void	error(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log error message.
java.util.logging.Logger	getLogger() Get the underlying JDK Logger instance.
void	info(java.lang.String msg, java.lang.Object... parameters) Log info message.
void	info(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log info message.
boolean	isDebugLoggable() Check whether this log is active for level debug.
boolean	isErrorLoggable() Check whether this log is active for level error.
boolean	isInfoLoggable() Check whether this log is active for level info.
boolean	isLoggable(java.util.logging.Level level) Check whether this log is active for a specific level.
boolean	isNoticeLoggable() Check whether this log is active for level notice.
boolean	isTraceLoggable() Check whether this log is active for level trace.
boolean	isWarningLoggable() Check whether this log is active for level warning.
void	log(java.util.logging.Level level, java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Issue a log message.
void	notice(java.lang.String msg, java.lang.Object... parameters) Log notice message.
void	notice(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log notice message.
void	trace(java.lang.String msg, java.lang.Object... parameters) Log trace message.
void	trace(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log trace message.
void	warning(java.lang.String msg, java.lang.Object... parameters) Log warning message.
void	warning(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Log

public Log()

Construct Log.

The logger name is automatically derived from the calling class.

Log

public Log(java.util.ResourceBundle bundle)

Construct Log.

The logger name is automatically derived from the calling class.

Parameters:

bundle - The ResourceBundle to use for message localization.

Log

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

Construct Log.

Parameters:

cls - The Class defining the logger name.

Log

public Log(java.lang.Class<?> cls,
           @Nullable
           java.util.ResourceBundle bundle)

Construct Log.

Parameters:

cls - The Class defining the logger name.

bundle - The ResourceBundle to use for message localization.

Log

public Log(java.lang.String name)

Construct Log.

Parameters:

name - The logger name to use.

Log

public Log(java.lang.String name,
           @Nullable
           java.util.ResourceBundle bundle)

Construct Log.

Parameters:

name - The logger name to use.

bundle - The ResourceBundle to use for message localization.

Method Detail

getLogger

public java.util.logging.Logger getLogger()

Get the underlying JDK Logger instance.

Returns:

The underlying JDK Logger instance.

isLoggable

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

Check whether this log is active for a specific level.

Parameters:

level - The level to check.

Returns:

true if this log is active for the submitted level.

log

public void log(java.util.logging.Level level,
                @Nullable
                java.lang.Throwable thrown,
                java.lang.String msg,
                java.lang.Object... parameters)

Issue a log message.

Parameters:

level - The log level to use.

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isNoticeLoggable

public boolean isNoticeLoggable()

Check whether this log is active for level notice.

Returns:

true if this log is active for level notice.

notice

public void notice(java.lang.String msg,
                   java.lang.Object... parameters)

Log notice message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

notice

public void notice(@Nullable
                   java.lang.Throwable thrown,
                   java.lang.String msg,
                   java.lang.Object... parameters)

Log notice message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isErrorLoggable

public boolean isErrorLoggable()

Check whether this log is active for level error.

Returns:

true if this log is active for level error.

error

public void error(java.lang.String msg,
                  java.lang.Object... parameters)

Log error message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

error

public void error(@Nullable
                  java.lang.Throwable thrown,
                  java.lang.String msg,
                  java.lang.Object... parameters)

Log error message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isWarningLoggable

public boolean isWarningLoggable()

Check whether this log is active for level warning.

Returns:

true if this log is active for level warning.

warning

public void warning(java.lang.String msg,
                    java.lang.Object... parameters)

Log warning message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

warning

public void warning(@Nullable
                    java.lang.Throwable thrown,
                    java.lang.String msg,
                    java.lang.Object... parameters)

Log warning message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isInfoLoggable

public boolean isInfoLoggable()

Check whether this log is active for level info.

Returns:

true if this log is active for level info.

info

public void info(java.lang.String msg,
                 java.lang.Object... parameters)

Log info message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

info

public void info(@Nullable
                 java.lang.Throwable thrown,
                 java.lang.String msg,
                 java.lang.Object... parameters)

Log info message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isDebugLoggable

public boolean isDebugLoggable()

Check whether this log is active for level debug.

Returns:

true if this log is active for level debug.

debug

public void debug(java.lang.String msg,
                  java.lang.Object... parameters)

Log debug message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

debug

public void debug(@Nullable
                  java.lang.Throwable thrown,
                  java.lang.String msg,
                  java.lang.Object... parameters)

Log debug message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.

isTraceLoggable

public boolean isTraceLoggable()

Check whether this log is active for level trace.

Returns:

true if this log is active for level trace.

trace

public void trace(java.lang.String msg,
                  java.lang.Object... parameters)

Log trace message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

trace

public void trace(@Nullable
                  java.lang.Throwable thrown,
                  java.lang.String msg,
                  java.lang.Object... parameters)

Log trace message.

Parameters:

thrown - The optional Throwable to log.

msg - The message to log.

parameters - The message parameters to log.