org.apache.log4j.rule
Class AndRule

java.lang.Object
  extended by org.apache.log4j.rule.AbstractRule
      extended by org.apache.log4j.rule.AndRule
All Implemented Interfaces:
java.io.Serializable, Rule

public class AndRule
extends AbstractRule

A Rule class implementing a logical 'and'.

Author:
Scott Deboy (sdeboy@apache.org)
See Also:
Serialized Form

Method Summary
 boolean evaluate(org.apache.log4j.spi.LoggingEvent event, java.util.Map matches)
          Returns true if this implementation of the rule accepts the LoggingEvent, or false if not.
static Rule getRule(Rule firstParam, Rule secondParam)
          Get rule.
static Rule getRule(java.util.Stack stack)
          Create rule from top two elements of stack.
 
Methods inherited from class org.apache.log4j.rule.AbstractRule
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRule

public static Rule getRule(java.util.Stack stack)
Create rule from top two elements of stack.

Parameters:
stack - stack of rules.
Returns:
Rule that evaluates true only if both rules are true.

getRule

public static Rule getRule(Rule firstParam,
                           Rule secondParam)
Get rule.

Parameters:
firstParam - first rule.
secondParam - second rule.
Returns:
Rule that evaluates true only if both rules are true.

evaluate

public boolean evaluate(org.apache.log4j.spi.LoggingEvent event,
                        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:
event - 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.


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.