de.carne.util.logging

Class Log

java.lang.Object

de.carne.util.logging.Log

public final class Log
extends java.lang.Object

Wrapper class for the JDK's Logger class to make logging easy and efficient.

Constructor Summary

Constructors

Constructor and Description
Log() Construct Log.
Log(java.lang.Class<?> clazz) Construct Log.
Log(java.lang.Class<?> clazz, java.lang.String resourceBundleName) Construct Log.
Log(java.lang.String resourceBundleName) Construct Log.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_DEBUG message.
void	debug(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_DEBUG message.
void	error(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_ERROR message.
void	error(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_ERROR message.
void	info(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_INFO message.
void	info(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_INFO message.
boolean	isDebugLoggable() Check whether a LogLevel.LEVEL_DEBUG message of level would be logged by this Log.
boolean	isErrorLoggable() Check whether a LogLevel.LEVEL_ERROR message of level would be logged by this Log.
boolean	isInfoLoggable() Check whether a LogLevel.LEVEL_INFO message of level would be logged by this Log.
boolean	isLoggable(java.util.logging.Level level) Check whether a message of the submitted Level would be logged by this Log.
boolean	isNoticeLoggable() Check whether a LogLevel.LEVEL_NOTICE message of level would be logged by this Log.
boolean	isTraceLoggable() Check whether a LogLevel.LEVEL_TRACE message of level would be logged by this Log.
boolean	isWarningLoggable() Check whether a LogLevel.LEVEL_WARNING message of level would be logged by this Log.
void	log(java.util.logging.Level level, java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a message with the given severity.
java.util.logging.Logger	logger() Get the Logger represented by this instance.
void	notice(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_NOTICE message.
void	notice(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_NOTICE message.
java.lang.String	toString()
void	trace(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_TRACE message.
void	trace(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_TRACE message.
void	warning(java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_WARNING message.
void	warning(java.lang.Throwable thrown, java.lang.String msg, java.lang.Object... parameters) Log a LogLevel.LEVEL_WARNING message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Log

public Log()

Construct Log.

The created Logger is named after the calling class' name.

Log

public Log(java.lang.String resourceBundleName)

Construct Log.

The created Logger is named after the calling class' name.

Parameters:

resourceBundleName - The name of the ResourceBundle to use for log message localization.

Log

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

Construct Log.

Parameters:

clazz - The Class to use for the Logger name.

Log

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

Construct Log.

Parameters:

clazz - The Class to use for the Logger name.

resourceBundleName - The name of the ResourceBundle to use for log message localization.

Method Detail

logger

public java.util.logging.Logger logger()

Get the Logger represented by this instance.

Returns:

The Logger represented by this instance.

isLoggable

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

Check whether a message of the submitted Level would be logged by this Log.

Parameters:

level - The Level to check.

Returns:

true if the submitted Level is enabled.

log

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

Log a message with the given severity.

Parameters:

level - The Level of the message.

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isNoticeLoggable

public boolean isNoticeLoggable()

Check whether a LogLevel.LEVEL_NOTICE message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_NOTICE is enabled.

notice

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

Log a LogLevel.LEVEL_NOTICE message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

notice

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

Log a LogLevel.LEVEL_NOTICE message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isErrorLoggable

public boolean isErrorLoggable()

Check whether a LogLevel.LEVEL_ERROR message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_ERROR is enabled.

error

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

Log a LogLevel.LEVEL_ERROR message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

error

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

Log a LogLevel.LEVEL_ERROR message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isWarningLoggable

public boolean isWarningLoggable()

Check whether a LogLevel.LEVEL_WARNING message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_WARNING is enabled.

warning

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

Log a LogLevel.LEVEL_WARNING message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

warning

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

Log a LogLevel.LEVEL_WARNING message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isInfoLoggable

public boolean isInfoLoggable()

Check whether a LogLevel.LEVEL_INFO message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_INFO is enabled.

info

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

Log a LogLevel.LEVEL_INFO message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

info

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

Log a LogLevel.LEVEL_INFO message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isDebugLoggable

public boolean isDebugLoggable()

Check whether a LogLevel.LEVEL_DEBUG message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_DEBUG is enabled.

debug

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

Log a LogLevel.LEVEL_DEBUG message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

debug

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

Log a LogLevel.LEVEL_DEBUG message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

isTraceLoggable

public boolean isTraceLoggable()

Check whether a LogLevel.LEVEL_TRACE message of level would be logged by this Log.

Returns:

true if LogLevel.LEVEL_TRACE is enabled.

trace

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

Log a LogLevel.LEVEL_TRACE message.

Parameters:

msg - The message to log.

parameters - The message parameters to log.

trace

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

Log a LogLevel.LEVEL_TRACE message.

Parameters:

thrown - The Throwable related to the message (may be null).

msg - The message to log.

parameters - The message parameters to log.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object