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:
  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      Serialization id.
      See Also:
    • 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