org.apache.log4j.filter

## Class LoggerMatchFilter

- java.lang.Object
- - org.apache.log4j.spi.Filter
  - - org.apache.log4j.filter.LoggerMatchFilter

- All Implemented Interfaces:
    org.apache.log4j.spi.OptionHandler

      public class LoggerMatchFilter
      extends org.apache.log4j.spi.Filter

  This is a very simple filter based on logger name matching.

  The filter admits two options LoggerToMatch and AcceptOnMatch. If there is an exact match between the value of the LoggerToMatch option and the logger of the `LoggingEvent`, then the `decide(org.apache.log4j.spi.LoggingEvent)` method returns `Filter.ACCEPT` in case the AcceptOnMatch option value is set to `true`, if it is `false` then `Filter.DENY` is returned. If there is no match, `Filter.NEUTRAL` is returned. A loggerToMatch of "root" matches both the root logger and a logger named "root".

- - ### Field Summary

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

      `ACCEPT, DENY, NEUTRAL, next`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `LoggerMatchFilter()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `decide(org.apache.log4j.spi.LoggingEvent event)`
    `boolean` | `getAcceptOnMatch()` Gets whether a match should result in acceptance.
    `String` | `getLoggerToMatch()` Gets logger name.
    `void` | `setAcceptOnMatch(boolean acceptOnMatch)` Sets whether a match should result in acceptance.
    `void` | `setLoggerToMatch(String logger)` Sets logger name.

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

    - #### LoggerMatchFilter

          public LoggerMatchFilter()

  - ### Method Detail

    - #### setLoggerToMatch

          public void setLoggerToMatch(String logger)

      Sets logger name.
      Parameters:
        `logger` - logger name.

    - #### getLoggerToMatch

          public String getLoggerToMatch()

      Gets logger name.
      Returns:
        logger name.

    - #### setAcceptOnMatch

          public void setAcceptOnMatch(boolean acceptOnMatch)

      Sets whether a match should result in acceptance.
      Parameters:
        `acceptOnMatch` - if true, accept if logger name matches, otherwise reject.

    - #### getAcceptOnMatch

          public boolean getAcceptOnMatch()

      Gets whether a match should result in acceptance.
      Returns:
        true if event is accepted if logger name matches.

    - #### decide

          public int decide(org.apache.log4j.spi.LoggingEvent event)

      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.