org.josef.util

Class LogUtil

java.lang.Object

org.josef.util.LogUtil

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2011-01-28",
        reason="Initial review")
public final class LogUtil
extends Object

Collection of Logging related methods.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.logging.log4j.Logger	genericLogger Generic logger.

Method Summary

Modifier and Type	Method and Description
static void	log(org.apache.logging.log4j.Logger logger, org.apache.logging.log4j.Level level, String message) Logs the supplied message.
static void	log(org.apache.logging.log4j.Logger logger, org.apache.logging.log4j.Level level, String message, Object... parameters) Logs the supplied message as a formatted message with parameters.

Methods inherited from class java.lang.Object

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

Field Detail

genericLogger

public static final org.apache.logging.log4j.Logger genericLogger

Generic logger.
A static reference is maintained since loggers normally use weak references and can be garbage collected.

Method Detail

log

public static void log(org.apache.logging.log4j.Logger logger,
                       org.apache.logging.log4j.Level level,
                       String message)

Logs the supplied message.
The advantage of this method is that it avoids checking the log level. Compare:

 if (LOGGER.isEnabled(Level.DEBUG)) {
     LOGGER.debug("The message");
 }

to using: LogUtil.log(log, Level.DEBUG, "The message");
It saves a few lines and has a lower McCabe score than the example above.
Note: When creating the message is expensive (memory or CPU intensive), you still need to resort to the if construct.

Parameters:

logger - The logger to log the supplied message to.
When null, no message will be logged without warning.

level - The log level.
When the supplied level is lower than the log level of the supplied logger, the message will not be logged.

message - The message to log.

log

public static void log(org.apache.logging.log4j.Logger logger,
                       org.apache.logging.log4j.Level level,
                       String message,
                       Object... parameters)

Logs the supplied message as a formatted message with parameters.
The advantage of this method is that it avoids checking the log level. Compare:

 if (LOGGER.isEnabled(Level.DEBUG)) {
     LOGGER.debug("The message", "param1", "param2");
 }

to using: LogUtil.log(log, Level.DEBUG, "The message", "param1", "param2")
It saves a few lines and has a lower McCabe score than the example above.
Note: When creating the message is expensive (memory or CPU intensive), you can resort to using a lambda expression. for example:
LOGGER.info(() -> timeConsumingMethod());

Parameters:

logger - The logger to log the supplied message to.
When null, no message will be logged without warning.

level - The log level.
When the supplied level is lower than the log level of the supplied logger, the message will not be logged.

message - The message to log.

parameters - Parameters to the message.