org.apache.logging.log4j.core.filter

Class LevelRangeFilter

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilter

org.apache.logging.log4j.core.filter.LevelRangeFilter

All Implemented Interfaces:

Filter, LifeCycle, LifeCycle2

@Plugin(name="LevelRangeFilter",
        category="Core",
        elementType="filter",
        printObject=true)
public final class LevelRangeFilter
extends AbstractFilter

This filter returns the onMatch result if the level in the LogEvent is in the range of the configured min and max levels, otherwise it returns onMismatch value . For example, if the filter is configured with Level.ERROR and Level.INFO and the LogEvent contains Level.WARN then the onMatch value will be returned since WARN events are in between ERROR and INFO.

The default Levels are both ERROR.

Nested Class Summary

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

Filter.Result

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.filter.AbstractFilter

onMatch, onMismatch

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.Filter

ELEMENT_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
static LevelRangeFilter	createFilter(Level minLevel, Level maxLevel, Filter.Result match, Filter.Result mismatch) Create a ThresholdFilter.
Filter.Result	filter(LogEvent event) Context Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, Message msg, Throwable t) Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, Object msg, Throwable t) Appender Filter method.
Filter.Result	filter(Logger logger, Level level, Marker marker, String msg, Object... params) Appender Filter method.
Level	getMinLevel()
String	toString()

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

equalsImpl, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, getOnMatch, getOnMismatch, hashCodeImpl

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

getState, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, 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

Method Detail

createFilter

@PluginFactory
public static LevelRangeFilter createFilter(@PluginAttribute(value="minLevel")
                                          Level minLevel,
                                          @PluginAttribute(value="maxLevel")
                                          Level maxLevel,
                                          @PluginAttribute(value="onMatch")
                                          Filter.Result match,
                                          @PluginAttribute(value="onMismatch")
                                          Filter.Result mismatch)

Create a ThresholdFilter.

Parameters:

minLevel - The minimum log Level.

maxLevel - The maximum log Level.

match - The action to take on a match.

mismatch - The action to take on a mismatch.

Returns:

The created ThresholdFilter.

filter

public Filter.Result filter(LogEvent event)

Description copied from class: AbstractFilter

Context Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

Parameters:

event - The LogEvent.

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
                   Level level,
                   Marker marker,
                   Message msg,
                   Throwable t)

Description copied from class: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

Parameters:

logger - the Logger.

level - The logging Level.

marker - The Marker, if any.

msg - The message, if present.

t - A throwable or null.

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
                   Level level,
                   Marker marker,
                   Object msg,
                   Throwable t)

Description copied from class: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

Parameters:

logger - the Logger.

level - The logging Level.

marker - The Marker, if any.

msg - The message, if present.

t - A throwable or null.

Returns:

The Result of filtering.

filter

public Filter.Result filter(Logger logger,
                   Level level,
                   Marker marker,
                   String msg,
                   Object... params)

Description copied from class: AbstractFilter

Appender Filter method. The default returns NEUTRAL.

Specified by:

filter in interface Filter

Overrides:

filter in class AbstractFilter

Parameters:

logger - the Logger.

level - The logging Level.

marker - The Marker, if any.

msg - The message, if present.

params - An array of parameters or null.

Returns:

The Result of filtering.

getMinLevel

public Level getMinLevel()

toString

public String toString()

Overrides:

toString in class AbstractFilter