org.apache.log4j.rule
Class ColorRule

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

public class ColorRule
extends AbstractRule
implements java.io.Serializable

A Rule class which also holds a color.

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

Constructor Summary
ColorRule(java.lang.String expression, Rule rule, java.awt.Color backgroundColor, java.awt.Color foregroundColor)
          Create new instance.
 
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.
 java.awt.Color getBackgroundColor()
          Get background color.
 java.lang.String getExpression()
          Get expression.
 java.awt.Color getForegroundColor()
          Get foreground color.
 Rule getRule()
          Get rule.
 java.lang.String toString()
          
 
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, wait, wait, wait
 

Constructor Detail

ColorRule

public ColorRule(java.lang.String expression,
                 Rule rule,
                 java.awt.Color backgroundColor,
                 java.awt.Color foregroundColor)
Create new instance.

Parameters:
expression - expression.
rule - rule.
backgroundColor - background color.
foregroundColor - foreground color.
Method Detail

getRule

public Rule getRule()
Get rule.

Returns:
underlying rule.

getForegroundColor

public java.awt.Color getForegroundColor()
Get foreground color.

Returns:
foreground color.

getBackgroundColor

public java.awt.Color getBackgroundColor()
Get background color.

Returns:
background color.

getExpression

public java.lang.String getExpression()
Get expression.

Returns:
expression.

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.

Specified by:
evaluate in interface Rule
Parameters:
event - LoggingEvent this instance will evaluate
Returns:
true if this Rule instance accepts the event, otherwise false.

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object


Copyright © 2007 Apache Software Foundation. All Rights Reserved.