Class LevelMatchFilter

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

    public class LevelMatchFilter
    extends org.apache.log4j.spi.Filter
    This is a very simple filter based on level matching.

    The filter admits two options LevelToMatch and AcceptOnMatch. If there is an exact match between the value of the LevelToMatch option and the level 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.

    Since:
    1.2
    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) boolean acceptOnMatch
      Do we return ACCEPT when a match occurs.
      (package private) org.apache.log4j.Level levelToMatch  
      • Fields inherited from class org.apache.log4j.spi.Filter

        ACCEPT, DENY, NEUTRAL, next
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int decide​(org.apache.log4j.spi.LoggingEvent event)
      Return the decision of this filter.
      boolean getAcceptOnMatch()  
      java.lang.String getLevelToMatch()  
      void setAcceptOnMatch​(boolean acceptOnMatch)  
      void setLevelToMatch​(java.lang.String level)  
      • 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
    • Field Detail

      • acceptOnMatch

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

        org.apache.log4j.Level levelToMatch
    • Constructor Detail

      • LevelMatchFilter

        public LevelMatchFilter()
    • Method Detail

      • setLevelToMatch

        public void setLevelToMatch​(java.lang.String level)
      • getLevelToMatch

        public java.lang.String getLevelToMatch()
      • setAcceptOnMatch

        public void setAcceptOnMatch​(boolean acceptOnMatch)
      • getAcceptOnMatch

        public boolean getAcceptOnMatch()
      • decide

        public int decide​(org.apache.log4j.spi.LoggingEvent event)
        Return the decision of this filter. Returns Filter.NEUTRAL if the LevelToMatch option is not set or if there is not match. Otherwise, if there is a match, then the returned decision is Filter.ACCEPT if the AcceptOnMatch property is set to true. The returned decision is Filter.DENY if the AcceptOnMatch property is set to false.
        Specified by:
        decide in class org.apache.log4j.spi.Filter