Class Reload4jLoggerContext
- java.lang.Object
-
- com.github.robtimus.junit.support.extension.testlogger.Reload4jLoggerContext
-
public final class Reload4jLoggerContext extends Object
Reload4jLoggerContext
represents a reload4jLogger
. It can be injected usingTestLogger
,TestLogger.ForClass
orTestLogger.Root
, and can be used to configure the logger for test purposes.Note: reloadj4 is based on Log4j 1.x. As a result, this class can most likely also be used with Log4j 1.x. However, no guarantees are made.
- Author:
- Rob Spoor
- Since:
- 2.1
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Reload4jLoggerContext
addAppender(Appender appender)
Adds an appender to the logger.LogCaptor<LoggingEvent>
capture()
Returns an object that captures logged events.Reload4jLoggerContext
removeAppender(Appender appender)
Removes an appender from the logger.Reload4jLoggerContext
removeAppenders()
Removes all appenders from the logger.Reload4jLoggerContext
removeAppenders(Predicate<? super Appender> filter)
Removes all appenders from the logger that match a filter.void
restore()
Restores the original settings of the logger.Reload4jLoggerContext
setAppender(Appender appender)
Sets the single appender for the logger.Reload4jLoggerContext
setLevel(Level level)
Sets the new level for the logger.Reload4jLoggerContext
useParentAppenders(boolean useParentAppenders)
Sets whether or not to use parent appenders for the logger.
-
-
-
Method Detail
-
setLevel
public Reload4jLoggerContext setLevel(Level level)
Sets the new level for the logger.- Parameters:
level
- The new level.- Returns:
- This object.
- Throws:
NullPointerException
- If the given level isnull
.
-
addAppender
public Reload4jLoggerContext addAppender(Appender appender)
Adds an appender to the logger.- Parameters:
appender
- The appender to add.- Returns:
- This object.
- Throws:
NullPointerException
- If the given appender isnull
.
-
setAppender
public Reload4jLoggerContext setAppender(Appender 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 isnull
.
-
removeAppender
public Reload4jLoggerContext removeAppender(Appender appender)
Removes an appender from the logger.- Parameters:
appender
- The appender to remove.- Returns:
- This object.
- Throws:
NullPointerException
- If the given appender isnull
.
-
removeAppenders
public Reload4jLoggerContext removeAppenders()
Removes all appenders from the logger.- Returns:
- This object.
-
removeAppenders
public Reload4jLoggerContext removeAppenders(Predicate<? super Appender> 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 isnull
.
-
useParentAppenders
public Reload4jLoggerContext 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<LoggingEvent> 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.
-
-