Class PartialTextMatchRule

  • All Implemented Interfaces:
    java.io.Serializable, Rule

    public class PartialTextMatchRule
    extends AbstractRule
    A Rule class implementing case-insensitive partial-text matches against two strings.
    See Also:
    Serialized Form
    • Field Detail

      • field

        private final java.lang.String field
        Field.
      • value

        private final java.lang.String value
        Value.
    • Constructor Detail

      • PartialTextMatchRule

        private PartialTextMatchRule​(java.lang.String field,
                                     java.lang.String value)
        Create new instance.
        Parameters:
        field - field
        value - value
    • Method Detail

      • getRule

        public static Rule getRule​(java.lang.String field,
                                   java.lang.String value)
        Create new instance.
        Parameters:
        field - field
        value - value
        Returns:
        new instance
      • getRule

        public static Rule getRule​(java.util.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,
                                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.