Top Description Methods
ch.qos.logback.core.boolex

public Interface EventEvaluator<E>

extends ContextAware, LifeCycle
Known Direct Implementers
ch.qos.logback.core.boolex.EventEvaluatorBase
Imports
ch.qos.logback.core.spi.ContextAware, .LifeCycle
Evaluates whether a given an event matches user-specified criteria.

Implementations are free to evaluate the event as they see fit. In particular, the evaluation results may depend on previous events.

Author
Ceki Gülcü

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if there is a match, false otherwise.
evaluate(E
The event to evaluate
event)

Evaluates whether the event passed as parameter matches some user-specified criteria.

public String

Returns:

The name of this evaluator.
getName()

Evaluators are named entities.

public void
setName(String name)

Evaluators are named entities.

Inherited from ch.qos.logback.core.spi.ContextAware:
addErroraddErroraddInfoaddInfoaddStatusaddWarnaddWarngetContextsetContext
Inherited from ch.qos.logback.core.spi.LifeCycle:
isStartedstartstop

Method Detail

evaluateback to summary
public boolean evaluate(E event) throws NullPointerException, EvaluationException

Evaluates whether the event passed as parameter matches some user-specified criteria.

The Evaluator is free to evaluate the event as it pleases. In particular, the evaluation results may depend on previous events.

Parameters
event:E

The event to evaluate

Returns:boolean

true if there is a match, false otherwise.

Exceptions
NullPointerException:
can be thrown in presence of null values
EvaluationException:
may be thrown during faulty evaluation
getNameback to summary
public String getName()

Evaluators are named entities.

Returns:String

The name of this evaluator.

setNameback to summary
public void setName(String name)

Evaluators are named entities.