Class ColorRule

java.lang.Object

org.apache.log4j.rule.AbstractRule

org.apache.log4j.rule.ColorRule

All Implemented Interfaces:

Serializable, Rule

public class ColorRule
extends AbstractRule
implements Serializable

A Rule class which also holds a color.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final Color	backgroundColor	Background color.
private final String	expression	Expression.
private final Color	foregroundColor	Foreground color.
private final Rule	rule	Wrapped rule.
(package private) static final long	serialVersionUID	Serialization id.

Constructor Summary

Constructors

Constructor	Description
ColorRule(String expression, Rule rule, Color backgroundColor, Color foregroundColor)	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.
Color	getBackgroundColor()	Get background color.
String	getExpression()	Get expression.
Color	getForegroundColor()	Get foreground color.
Rule	getRule()	Get rule.
String	toString()

Methods inherited from class AbstractRule

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class Object

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

Field Details

serialVersionUID

static final long serialVersionUID

Serialization id.

See Also:

• Constant Field Values

rule

private final Rule rule

Wrapped rule.

foregroundColor

private final Color foregroundColor

Foreground color.

backgroundColor

private final Color backgroundColor

Background color.

expression

private final String expression

Expression.

Constructor Details

ColorRule

public ColorRule(String expression,
 Rule rule,
 Color backgroundColor,
 Color foregroundColor)

Create new instance.

Parameters:

expression - expression.

rule - rule.

backgroundColor - background color.

foregroundColor - foreground color.

Method Details

getRule

public Rule getRule()

Get rule.

Returns:

underlying rule.

getForegroundColor

public Color getForegroundColor()

Get foreground color.

Returns:

foreground color.

getBackgroundColor

public Color getBackgroundColor()

Get background color.

Returns:

background color.

getExpression

public String getExpression()

Get expression.

Returns:

expression.

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.

Specified by:

evaluate in interface Rule

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.

toString

public String toString()

Overrides:

toString in class Object