Save This Page
Home » slf4j-1.5.5 » org.apache » log4j » varia » [javadoc | source]
org.apache.log4j.varia
public class: LevelRangeFilter [javadoc | source]
java.lang.Object
   org.apache.log4j.spi.Filter
      org.apache.log4j.varia.LevelRangeFilter

All Implemented Interfaces:
    OptionHandler

This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.

The filter admits three options LevelMin, LevelMax and AcceptOnMatch.

If the level of the LoggingEvent is not between Min and Max (inclusive), then Filter#DENY is returned.

If the Logging event level is within the specified range, then if AcceptOnMatch is true, Filter#ACCEPT is returned, and if AcceptOnMatch is false, Filter#NEUTRAL is returned.

If LevelMinw is not defined, then there is no minimum acceptable level (ie a level is never rejected for being too "low"/unimportant). If LevelMax is not defined, then there is no maximum acceptable level (ie a level is never rejected for beeing too "high"/important).

Refer to the setThreshold method available to all appenders extending org.apache.log4j.AppenderSkeleton for a more convenient way to filter out events by level.

Field Summary
 boolean acceptOnMatch    Do we return ACCEPT when a match occurs. Default is false, so that later filters get run by default 
 Level levelMin     
 Level levelMax     
Fields inherited from org.apache.log4j.spi.Filter:
next,  DENY,  NEUTRAL,  ACCEPT
Method from org.apache.log4j.varia.LevelRangeFilter Summary:
decide,   getAcceptOnMatch,   getLevelMax,   getLevelMin,   setAcceptOnMatch,   setLevelMax,   setLevelMin
Methods from org.apache.log4j.spi.Filter:
activateOptions,   decide,   getNext,   setNext
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.log4j.varia.LevelRangeFilter Detail:
 public int decide(LoggingEvent event) 
    Return the decision of this filter.
 public boolean getAcceptOnMatch() 
    Get the value of the AcceptOnMatch option.
 public Level getLevelMax() 
    Get the value of the LevelMax option.
 public Level getLevelMin() 
    Get the value of the LevelMin option.
 public  void setAcceptOnMatch(boolean acceptOnMatch) 
    Set the AcceptOnMatch option.
 public  void setLevelMax(Level levelMax) 
    Set the LevelMax option.
 public  void setLevelMin(Level levelMin) 
    Set the LevelMin option.