Class StringMatchFilter

java.lang.Object
org.apache.log4j.spi.Filter
org.apache.log4j.filter.StringMatchFilter
All Implemented Interfaces:
org.apache.log4j.spi.OptionHandler
public class StringMatchFilter extends org.apache.log4j.spi.Filter
This is a very simple filter based on string matching.

The filter admits two options StringToMatch and AcceptOnMatch. If there is a match between the value of the StringToMatch option and the message of the LoggingEvent, then the decide(LoggingEvent) method returns Filter.ACCEPT if the AcceptOnMatch option value is true, if it is false then Filter.DENY is returned. If there is no match, Filter.NEUTRAL is returned.

Since:
0.9.0

  • Field Details

    • acceptOnMatch

      boolean acceptOnMatch

    • stringToMatch

      String stringToMatch

  • Constructor Details

    • StringMatchFilter

      public StringMatchFilter()

  • Method Details

    • setStringToMatch

      public void setStringToMatch(String s)

    • getStringToMatch

      public String getStringToMatch()

    • setAcceptOnMatch

      public void setAcceptOnMatch(boolean acceptOnMatch)

    • getAcceptOnMatch

      public boolean getAcceptOnMatch()

    • decide

      public int decide(org.apache.log4j.spi.LoggingEvent event)
      Returns Filter.NEUTRAL is there is no string match.
      Specified by:
      decide in class org.apache.log4j.spi.Filter