org.apache.log4j.filter

## 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
  Author:
    Ceki Gülcü

- - ### Field Summary

    - ### Fields inherited from class org.apache.log4j.spi.Filter

      `ACCEPT, DENY, NEUTRAL, next`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StringMatchFilter()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `decide(org.apache.log4j.spi.LoggingEvent event)` Returns `Filter.NEUTRAL` is there is no string match.
    `boolean` | `getAcceptOnMatch()`
    `String` | `getStringToMatch()`
    `void` | `setAcceptOnMatch(boolean acceptOnMatch)`
    `void` | `setStringToMatch(String s)`

    - ### Methods inherited from class org.apache.log4j.spi.Filter

      `activateOptions, getNext, setNext`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### StringMatchFilter

          public StringMatchFilter()

  - ### Method Detail

    - #### 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`

Copyright © 2013 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.