Package nva.commons.logutils

Class LogUtils

java.lang.Object

nva.commons.logutils.LogUtils

public final class LogUtils
extends Object

Methods for testing logging when using Log4j2 as logging platform. Can be used when using SLF4J as well with Log4j2 as background logging platform.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_CLASS_NAME_AND_MESSAGE
static final String	PACKAGES_WITH_APPENDERS
static final String	PATTERN_ATTRIBUTE_NAME
static final String	ROOT_NULL_APPENDER

Method Summary

Modifier and Type	Method	Description
static <T> TestAppender	getTestingAppender(Class<T> clazz)	This method should ALWAYS be called before the creation of the object you want to test.
static <T> TestAppender	getTestingAppenderForRootLogger()	This method should ALWAYS be called before the creation of the object you want to test.
static String	toLoggerName(Class<?> cls)	From LogManager.getLogger()

Methods inherited from class java.lang.Object

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

Field Details

PATTERN_ATTRIBUTE_NAME

public static final String PATTERN_ATTRIBUTE_NAME

See Also:

• Constant Field Values

LOG_CLASS_NAME_AND_MESSAGE

public static final String LOG_CLASS_NAME_AND_MESSAGE

See Also:

• Constant Field Values

ROOT_NULL_APPENDER

public static final String ROOT_NULL_APPENDER

See Also:

• Constant Field Values

PACKAGES_WITH_APPENDERS

public static final String PACKAGES_WITH_APPENDERS

See Also:

• Constant Field Values

Method Details

getTestingAppender

public static <T> TestAppender getTestingAppender(Class<T> clazz)

This method should ALWAYS be called before the creation of the object you want to test.

The method was created based on the patterns for programmatically configuring Log4j (https://logging.apache.org/log4j/2.x/manual/customconfig.html)

Type Parameters:

T - The class of the object under test

Parameters:

clazz - The class of the object under test.

Returns:

a TestAppender

getTestingAppenderForRootLogger

public static <T> TestAppender getTestingAppenderForRootLogger()

This method should ALWAYS be called before the creation of the object you want to test.

The method was created based on the patterns for programmatically configuring Log4j (https://logging.apache.org/log4j/2.x/manual/customconfig.html)

Type Parameters:

T - The class of the object under test

Returns:

a TestAppender

toLoggerName

public static String toLoggerName(Class<?> cls)

From LogManager.getLogger()

Parameters:

cls - the class

Returns:

the logger name