Package ch.qos.logback.core.filter
Class Filter<E>
- java.lang.Object
-
- ch.qos.logback.core.spi.ContextAwareBase
-
- ch.qos.logback.core.filter.Filter<E>
-
- All Implemented Interfaces:
ContextAware
,LifeCycle
- Direct Known Subclasses:
AbstractMatcherFilter
,ThresholdFilter
public abstract class Filter<E> extends ContextAwareBase implements LifeCycle
Users should extend this class to implement customized event filtering.We suggest that you first try to use the built-in rules before rushing to write your own custom filters.
For more information about filters, please refer to the online manual at http://logback.qos.ch/manual/filters.html
-
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract FilterReply
decide(E event)
If the decision is
, then the event will be dropped.FilterReply.DENY
String
getName()
boolean
isStarted()
void
setName(String name)
void
start()
void
stop()
-
Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getStatusManager, setContext
-
-
-
-
Method Detail
-
decide
public abstract FilterReply decide(E event)
If the decision is
, then the event will be dropped. If the decision isFilterReply.DENY
, then the next filter, if any, will be invoked. If the decision isFilterReply.NEUTRAL
then the event will be logged without consulting with other filters in the chain.FilterReply.ACCEPT
- Parameters:
event
- The event to decide upon.
-
getName
public String getName()
-
setName
public void setName(String name)
-
-