Package org.apache.log4j.rule

Class LikeRule

java.lang.Object

org.apache.log4j.rule.AbstractRule

org.apache.log4j.rule.LikeRule

All Implemented Interfaces:

java.io.Serializable, Rule

public class LikeRule
extends AbstractRule

A Rule class supporting java.util.regex regular expression syntax.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	field	Field.
private java.util.regex.Matcher	matcher	Regular expression matcher.
private java.util.regex.Pattern	pattern	Pattern.
private static LoggingEventFieldResolver	RESOLVER	Resolver.
(package private) static long	serialVersionUID	Serialization ID.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LikeRule(java.lang.String field, java.util.regex.Pattern pattern)	Create new instance.

Method Summary

Modifier and Type	Method	Description
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(java.lang.String field, java.lang.String pattern)	Create new instance.
static Rule	getRule(java.util.Stack stack)	Create new instance from top two elements of stack.
private void	readObject(java.io.ObjectInputStream in)	Deserialize the state of the object.
private void	writeObject(java.io.ObjectOutputStream out)	Serialize the state of the object.

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

Field Detail

serialVersionUID

static final long serialVersionUID

Serialization ID.

See Also:

Constant Field Values

RESOLVER

private static final LoggingEventFieldResolver RESOLVER

Resolver.

pattern

private transient java.util.regex.Pattern pattern

Pattern.

matcher

private transient java.util.regex.Matcher matcher

Regular expression matcher.

field

private transient java.lang.String field

Field.

Constructor Detail

LikeRule

private LikeRule(java.lang.String field,
                 java.util.regex.Pattern pattern)

Create new instance.

Parameters:

field - field

pattern - pattern

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 field,
                           java.lang.String pattern)

Create new instance.

Parameters:

field - field

pattern - pattern

Returns:

new instance

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.

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Deserialize the state of the object.

Parameters:

in - object input stream

Throws:

java.io.IOException - if IOException during deserialization

java.lang.ClassNotFoundException - if class not found.

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Serialize the state of the object.

Parameters:

out - object output stream

Throws:

java.io.IOException - if IOException during serialization