public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
Filter.Result.NEUTRAL
.
Garbage-free note: the methods with unrolled varargs by default delegate to the
filter method with vararg parameters
.
Subclasses that want to be garbage-free should override these methods to implement the appropriate filtering
without creating a vararg array.
Modifier and Type | Class and Description |
---|---|
static class |
AbstractFilter.AbstractFilterBuilder<B extends AbstractFilter.AbstractFilterBuilder<B>> |
Filter.Result
LifeCycle.State
Modifier and Type | Field and Description |
---|---|
protected Filter.Result |
onMatch
The onMatch Result.
|
protected Filter.Result |
onMismatch
The onMismatch Result.
|
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
ELEMENT_TYPE, EMPTY_ARRAY
Modifier | Constructor and Description |
---|---|
protected |
AbstractFilter()
The default constructor.
|
protected |
AbstractFilter(Filter.Result onMatch,
Filter.Result onMismatch)
Constructor that allows the onMatch and onMismatch actions to be set.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
equalsImpl(Object obj) |
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.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5,
Object p6)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5,
Object p6,
Object p7)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5,
Object p6,
Object p7,
Object p8)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
String msg,
Object p0,
Object p1,
Object p2,
Object p3,
Object p4,
Object p5,
Object p6,
Object p7,
Object p8,
Object p9)
Appender Filter method.
|
Filter.Result |
getOnMatch()
Returns the Result to be returned when a match occurs.
|
Filter.Result |
getOnMismatch()
Returns the Result to be returned when a match does not occur.
|
protected int |
hashCodeImpl() |
String |
toString() |
getState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop
protected final Filter.Result onMatch
protected final Filter.Result onMismatch
protected AbstractFilter()
protected AbstractFilter(Filter.Result onMatch, Filter.Result onMismatch)
onMatch
- The result to return when a match occurs.onMismatch
- The result to return when a match dos not occur.protected boolean equalsImpl(Object obj)
equalsImpl
in class AbstractLifeCycle
public Filter.Result filter(LogEvent event)
public Filter.Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t)
public Filter.Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t)
public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object... params)
public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0)
public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1)
public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2)
public Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, String msg, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
filter
in interface Filter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parametersp9
- the message parameterspublic final Filter.Result getOnMatch()
getOnMatch
in interface Filter
public final Filter.Result getOnMismatch()
getOnMismatch
in interface Filter
protected int hashCodeImpl()
hashCodeImpl
in class AbstractLifeCycle
Copyright © 1999-2023 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.