org.apache.log4j.rule
Interface Rule

All Known Implementing Classes:
AbstractRule, AndRule, ColorRule, EqualsRule, ExistsRule, ExpressionRule, InequalityRule, LevelEqualsRule, LikeRule, NotEqualsRule, NotLevelEqualsRule, NotRule, OrRule, PartialTextMatchRule, TimestampEqualsRule, TimestampInequalityRule

public interface Rule

A Rule evaluates to true of false given a LoggingEvent object, and can notify listeners when the underlying implementation of this Rule has it's criteria changed by using the standard PropertyChangeListener infrastructure.

Author:
Paul Smith (psmith@apache.org), Scott Deboy (sdeboy@apache.org)

Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener to this instance, which is notified when underlying Rule information has changed.
 boolean evaluate(org.apache.log4j.spi.LoggingEvent e, java.util.Map matches)
          Returns true if this implementation of the rule accepts the LoggingEvent, or false if not.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a known PropertyChangeListener from this Rule.
 

Method Detail

evaluate

boolean evaluate(org.apache.log4j.spi.LoggingEvent e,
                 java.util.Map matches)
Returns true if this implementation of the rule accepts the LoggingEvent, or false if not.

What True/False means can be client-specific.

Parameters:
e - LoggingEvent this instance will evaluate
matches - a Map of event field keys to Sets of matching strings (may be null) which will be updated during execution of this method to include field and string matches based on the rule evaluation results
Returns:
true if this Rule instance accepts the event, otherwise false.

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener to this instance, which is notified when underlying Rule information has changed. (there are no specific property name events).

Parameters:
listener - listener

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a known PropertyChangeListener from this Rule.

Parameters:
listener - listener


Copyright © 2010 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras Companion for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.