java.lang.Object
- org.apache.logging.log4j.core.AbstractLifeCycle
- - org.apache.logging.log4j.core.filter.AbstractFilter
  - - org.apache.logging.log4j.core.filter.MapFilter

All Implemented Interfaces:: Filter, LifeCycle, LifeCycle2

Direct Known Subclasses:: StructuredDataFilter, ThreadContextMapFilter

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

A Filter that operates on a Map.

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 boolean isAnd

private IndexedStringMap map
- 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
`protected`	`MapFilter(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map, boolean oper, Filter.Result onMatch, Filter.Result onMismatch)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static MapFilter`	`createFilter(KeyValuePair[] pairs, java.lang.String oper, Filter.Result match, Filter.Result mismatch)`
`protected boolean`	`filter(java.util.Map<java.lang.String,java.lang.String> data)`
`Filter.Result`	`filter(LogEvent event)`	Context 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 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.
`protected boolean`	`filter(MapMessage<?,?> mapMessage)`
`protected boolean`	`filter(ReadOnlyStringMap data)`
`protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getMap()`	Deprecated. use `getStringMap()` instead
`protected IndexedReadOnlyStringMap`	`getStringMap()`	Returns the IndexedStringMap with `List<String>` values that this MapFilter was constructed with.
`protected boolean`	`isAnd()`
`java.lang.String`	`toString()`

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilter
equalsImpl, filter, filter, 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

map
```
private final IndexedStringMap map
```

isAnd
```
private final boolean isAnd
```

Constructor Detail

MapFilter

protected MapFilter(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map,
                    boolean oper,
                    Filter.Result onMatch,
                    Filter.Result onMismatch)

Method Detail

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(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

protected boolean filter(MapMessage<?,?> mapMessage)

filter

protected boolean filter(java.util.Map<java.lang.String,java.lang.String> data)

filter

protected boolean filter(ReadOnlyStringMap data)

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.