Class PartialTextMatchRule

java.lang.Object

org.apache.log4j.rule.AbstractRule

org.apache.log4j.rule.PartialTextMatchRule

All Implemented Interfaces:

Serializable, Rule

public class PartialTextMatchRule
extends AbstractRule

A Rule class implementing case-insensitive partial-text matches against two strings.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	field	Field.
private static final LoggingEventFieldResolver	RESOLVER	Resolver.
(package private) static final long	serialVersionUID	Serialization ID.
private final String	value	Value.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PartialTextMatchRule(String field, String value)	Create new instance.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(org.apache.log4j.spi.LoggingEvent event, Map matches)	Returns true if this implementation of the rule accepts the LoggingEvent, or false if not.
static Rule	getRule(String field, String value)	Create new instance.
static Rule	getRule(Stack stack)	Create new instance from top two elements of stack.

Methods inherited from class AbstractRule

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

static final long serialVersionUID

Serialization ID.

See Also:

• Constant Field Values

RESOLVER

private static final LoggingEventFieldResolver RESOLVER

Resolver.

field

private final String field

Field.

value

private final String value

Value.

Constructor Details

PartialTextMatchRule

private PartialTextMatchRule(String field,
 String value)

Create new instance.

Parameters:

field - field

value - value

Method Details

getRule

public static Rule getRule(String field,
 String value)

Create new instance.

Parameters:

field - field

value - value

Returns:

new instance

getRule

public static Rule getRule(Stack stack)

Create new instance from top two elements of stack.

Parameters:

stack - stack

Returns:

new instance

evaluate

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