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(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 Details

    • acceptOnMatch

      private boolean acceptOnMatch
      Do we return ACCEPT when a match occurs. Default is true.

    • loggerToMatch

      private String loggerToMatch
      Logger name, may be null or empty in which case it matches root.

  • Constructor Details

    • LoggerMatchFilter

      public LoggerMatchFilter()

  • Method Details

    • 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