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, CountingFilter, SampleFilter, 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

Field Summary

Fields

Modifier and Type	Field	Description
private String	name
(package private) boolean	start

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
Filter()

Method Summary

Modifier and Type	Method	Description
abstract FilterReply	decide(E event)	If the decision is FilterReply.DENY, then the event will be dropped.
String	getName()
boolean	isStarted()
void	setName(String name)
void	start()
void	stop()

Methods inherited from class ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

private String name

start

boolean start

Constructor Details

Filter

public Filter()

Method Details

start

public void start()

Specified by:

start in interface LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

decide

public abstract FilterReply decide(E event)

If the decision is FilterReply.DENY, then the event will be dropped. If the decision is FilterReply.NEUTRAL, then the next filter, if any, will be invoked. If the decision is FilterReply.ACCEPT then the event will be logged without consulting with other filters in the chain.

Parameters:

event - The event to decide upon.

getName

public String getName()

setName

public void setName(String name)