org.apache.log4j.varia: public class: LevelRangeFilter

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.

author: Simon - Kitching

author: based - on code by Ceki Gülcü

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) { if(this.levelMin != null) { if (event.getLevel().isGreaterOrEqual(levelMin) == false) { // level of event is less than minimum return Filter.DENY; } } if(this.levelMax != null) { if (event.getLevel().toInt() > levelMax.toInt()) { // level of event is greater than maximum // Alas, there is no Level.isGreater method. and using // a combo of isGreaterOrEqual && !Equal seems worse than // checking the int values of the level objects.. return Filter.DENY; } } if (acceptOnMatch) { // this filter set up to bypass later filters and always return // accept if level in range return Filter.ACCEPT; } else { // event is ok for this filter; allow later filters to have a look.. return Filter.NEUTRAL; } } Return the decision of this filter.
public boolean getAcceptOnMatch() { return acceptOnMatch; } Get the value of the `AcceptOnMatch` option.
public Level getLevelMax() { return levelMax; } Get the value of the `LevelMax` option.
public Level getLevelMin() { return levelMin; } Get the value of the `LevelMin` option.
public void setAcceptOnMatch(boolean acceptOnMatch) { this.acceptOnMatch = acceptOnMatch; } Set the `AcceptOnMatch` option.
public void setLevelMax(Level levelMax) { this.levelMax = levelMax; } Set the `LevelMax` option.
public void setLevelMin(Level levelMin) { this.levelMin = levelMin; } Set the `LevelMin` option.

Method from org.apache.log4j.varia.LevelRangeFilter Detail:

 public int decide(LoggingEvent event) {
 
    if(this.levelMin != null) {
      if (event.getLevel().isGreaterOrEqual(levelMin) == false) {
        // level of event is less than minimum
        return Filter.DENY;
      }
    }
    if(this.levelMax != null) {
      if (event.getLevel().toInt()  > levelMax.toInt()) {
        // level of event is greater than maximum
        // Alas, there is no Level.isGreater method. and using
        // a combo of isGreaterOrEqual && !Equal seems worse than
        // checking the int values of the level objects..
        return Filter.DENY;
      }
    }
    if (acceptOnMatch) {
      // this filter set up to bypass later filters and always return
      // accept if level in range
      return Filter.ACCEPT;
    }
    else {
      // event is ok for this filter; allow later filters to have a look..
      return Filter.NEUTRAL;
    }
}

Return the decision of this filter.

 public boolean getAcceptOnMatch() {
    return acceptOnMatch;
}

AcceptOnMatch

 public Level getLevelMax() {
    return levelMax;
}

LevelMax

 public Level getLevelMin() {
    return levelMin;
}

LevelMin

 public  void setAcceptOnMatch(boolean acceptOnMatch) {
    this.acceptOnMatch = acceptOnMatch;
}

AcceptOnMatch

 public  void setLevelMax(Level levelMax) {
    this.levelMax =  levelMax;
}

LevelMax

 public  void setLevelMin(Level levelMin) {
    this.levelMin =  levelMin;
}

LevelMin