Module com.github.robtimus.junit.support

Package com.github.robtimus.junit.support.extension.testlogger

Class LogbackLoggerContext

java.lang.Object

com.github.robtimus.junit.support.extension.testlogger.LogbackLoggerContext

public final class LogbackLoggerContext
extends Object

LogbackLoggerContext represents a logback Logger. It can be injected using TestLogger, TestLogger.ForClass or TestLogger.Root, and can be used to configure the logger for test purposes.

Author:

Rob Spoor

Since:

2.1

Method Summary

Modifier and Type	Method	Description
LogbackLoggerContext	addAppender(Appender<ILoggingEvent> appender)	Adds an appender to the logger.
LogCaptor<ILoggingEvent>	capture()	Returns an object that captures logged events.
LogbackLoggerContext	removeAppender(Appender<ILoggingEvent> appender)	Removes an appender from the logger.
LogbackLoggerContext	removeAppenders()	Removes all appenders from the logger.
LogbackLoggerContext	removeAppenders(Predicate<? super Appender<ILoggingEvent>> filter)	Removes all appenders from the logger that match a filter.
void	restore()	Restores the original settings of the logger.
LogbackLoggerContext	setAppender(Appender<ILoggingEvent> appender)	Sets the single appender for the logger.
LogbackLoggerContext	setLevel(Level level)	Sets the new level for the logger.
LogbackLoggerContext	useParentAppenders(boolean useParentAppenders)	Sets whether or not to use parent appenders for the logger.

Methods inherited from class java.lang.Object

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

Method Detail

setLevel

public LogbackLoggerContext setLevel(Level level)

Sets the new level for the logger.

Parameters:

level - The new level.

Returns:

This object.

Throws:

NullPointerException - If the given level is null.

addAppender

public LogbackLoggerContext addAppender(Appender<ILoggingEvent> appender)

Adds an appender to the logger.

Parameters:

appender - The appender to add.

Returns:

This object.

Throws:

NullPointerException - If the given appender is null.

setAppender

public LogbackLoggerContext setAppender(Appender<ILoggingEvent> appender)

Sets the single appender for the logger. All existing appenders will first be removed.

Parameters:

appender - The appender to set.

Returns:

This object.

Throws:

NullPointerException - If the given appender is null.

removeAppender

public LogbackLoggerContext removeAppender(Appender<ILoggingEvent> appender)

Removes an appender from the logger.

Parameters:

appender - The appender to remove.

Returns:

This object.

Throws:

NullPointerException - If the given appender is null.

removeAppenders

public LogbackLoggerContext removeAppenders()

Removes all appenders from the logger.

Returns:

This object.

removeAppenders

public LogbackLoggerContext removeAppenders(Predicate<? super Appender<ILoggingEvent>> filter)

Removes all appenders from the logger that match a filter.

Parameters:

filter - The filter to use.

Returns:

This object.

Throws:

NullPointerException - If the given filter is null.

useParentAppenders

public LogbackLoggerContext useParentAppenders(boolean useParentAppenders)

Sets whether or not to use parent appenders for the logger.

Parameters:

useParentAppenders - true to use parent appenders, false otherwise.

Returns:

This object.

capture

public LogCaptor<ILoggingEvent> capture()

Returns an object that captures logged events. This can be used instead of having to append a capturing appender manually.

Returns:

An object that captures logged events.

Since:

3.0

restore

public void restore()

Restores the original settings of the logger.

It should usually not be necessary to call this method, as it will be called automatically once this context goes out of scope.