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 class org.apache.logging.log4j.core.filter.AbstractFilter
  AbstractFilter.AbstractFilterBuilder<B extends AbstractFilter.AbstractFilterBuilder<B>>
- 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
Modifier and Type Field Description

private Level maxLevel

private Level minLevel
- 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, EMPTY_ARRAY

Constructor Summary

Constructors
Modifier	Constructor	Description
`private`	`LevelRangeFilter(Level minLevel, Level maxLevel, Filter.Result onMatch, Filter.Result onMismatch)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LevelRangeFilter`	`createFilter(Level minLevel, Level maxLevel, Filter.Result match, Filter.Result mismatch)`	Creates a ThresholdFilter.
`Filter.Result`	`filter(LogEvent event)`	Context Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.Object msg, java.lang.Throwable t)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object... params)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8, java.lang.Object p9)`	Appender Filter method.
`Filter.Result`	`filter(Logger logger, Level level, Marker marker, Message msg, java.lang.Throwable t)`	Appender Filter method.
`private Filter.Result`	`filter(Level level)`
`Level`	`getMaxLevel()`
`Level`	`getMinLevel()`
`java.lang.String`	`toString()`

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter
equalsImpl, getOnMatch, getOnMismatch, hashCodeImpl

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
getState, getStatusLogger, 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.Filter
filter

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle
getState, initialize, isStarted, isStopped, start, stop

Field Detail

maxLevel
```
private final Level maxLevel
```

minLevel
```
private final Level minLevel
```

Constructor Detail

LevelRangeFilter

private LevelRangeFilter(Level minLevel,
                         Level maxLevel,
                         Filter.Result onMatch,
                         Filter.Result onMismatch)

Method Detail

createFilter

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

Creates 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

private Filter.Result filter(Level level)

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,
                            java.lang.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,
                            java.lang.Object msg,
                            java.lang.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,
                            java.lang.String msg,
                            java.lang.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.

filter
```
public Filter.Result filter(Logger logger,
                            Level level,
                            Marker marker,
                            java.lang.String msg,
                            java.lang.Object p0)
```
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.

p0 - the message parameters

Returns:

The Result of filtering.

filter
```
public Filter.Result filter(Logger logger,
                            Level level,
                            Marker marker,
                            java.lang.String msg,
                            java.lang.Object p0,
                            java.lang.Object p1)
```
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.

p0 - the message parameters

p1 - the message parameters

Returns:

The Result of filtering.