org.apache.log4j.rule
Class EqualsRule

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

public class EqualsRule
extends AbstractRule

A Rule class which returns the result of performing equals against two strings.

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

Method Summary
 boolean evaluate(org.apache.log4j.spi.LoggingEvent event)
          Returns true if this implementation of the rule accepts the LoggingEvent, or false if not.
static Rule getRule(java.util.Stack stack)
          Create new instance from top two elements of stack.
static Rule getRule(java.lang.String p1, java.lang.String p2)
          Create new instance.
 
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 new instance from top two elements of stack.

Parameters:
stack - stack
Returns:
new instance

getRule

public static Rule getRule(java.lang.String p1,
                           java.lang.String p2)
Create new instance.

Parameters:
p1 - field, special treatment for level and timestamp.
p2 - value
Returns:
new instance

evaluate

public boolean evaluate(org.apache.log4j.spi.LoggingEvent event)
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
Returns:
true if this Rule instance accepts the event, otherwise false.


Copyright © 2007 Apache Software Foundation. All Rights Reserved.