Module com.github.robtimus.junit.support

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

Class Log4jNullAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

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

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

public class Log4jNullAppender
extends AbstractAppender

An appender that ignores events. This is much like NullAppender, except that append(LogEvent) calls ignore(LogEvent) with immutable events.

Author:

Rob Spoor

Since:

2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Log4jNullAppender.Builder	A builder for Log4jNullAppender instances.

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Log4jNullAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties)	Creates a new appender.

Method Summary

Modifier and Type	Method	Description
void	append(LogEvent event)	Delegates to ignore(LogEvent) with the result of calling LogEvent.toImmutable() on the given event.
static Log4jNullAppender	create(String name)	Creates a named appender.
void	ignore(LogEvent event)	Ignores an event.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Constructor Detail

Log4jNullAppender

protected Log4jNullAppender(String name,
                            Filter filter,
                            Layout<? extends Serializable> layout,
                            boolean ignoreExceptions,
                            Property[] properties)

Creates a new appender.

Parameters:

name - The appender name.

filter - The filter to associate with the appender.

layout - The layout to use to format the event.

ignoreExceptions - If true, exceptions will be logged and suppressed. If false errors will be logged and then passed to the application.

properties - An array of properties for the appender.

Method Detail

append

public final void append(LogEvent event)

Delegates to ignore(LogEvent) with the result of calling LogEvent.toImmutable() on the given event.

ignore

public void ignore(LogEvent event)

Ignores an event.

Parameters:

event - The event to ignore.

create

public static Log4jNullAppender create(String name)

Creates a named appender. This method does the same as calling new Builder().setName(name).build().

Parameters:

name - The appender name.

Returns:

The created appender.