LevelRangeFilter (Apache Log4j 1.2.17 API)
Date: 2012-05-06

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.log4j.varia
Class LevelRangeFilter

    java.lang.Object
      org.apache.log4j.spi.Filter
          org.apache.log4j.varia.LevelRangeFilter

All Implemented Interfaces:
  OptionHandler

    public class LevelRangeFilter

extends Filter

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 `LevelMin`w 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 `AppenderSkeleton` for a more convenient way to filter out events by level.

Author:
  Simon Kitching, based on code by Ceki Gülcü

Field Summary

Fields inherited from class org.apache.log4j.spi.Filter
`ACCEPT, DENY, NEUTRAL, next`

Constructor Summary
`LevelRangeFilter()`

Method Summary
`int` | `decide(LoggingEvent event)` Return the decision of this filter.
`boolean` | `getAcceptOnMatch()` Get the value of the `AcceptOnMatch` option.
`Level` | `getLevelMax()` Get the value of the `LevelMax` option.
`Level` | `getLevelMin()` Get the value of the `LevelMin` option.
`void` | `setAcceptOnMatch(boolean acceptOnMatch)` Set the `AcceptOnMatch` option.
`void` | `setLevelMax(Level levelMax)` Set the `LevelMax` option.
`void` | `setLevelMin(Level levelMin)` Set the `LevelMin` option.

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

### LevelRangeFilter

    public LevelRangeFilter()

Method Detail

### decide

    public int decide(LoggingEvent event)

  Return the decision of this filter.

  Specified by:
    `decide` in class `Filter`
  Parameters:
    `event` - The LoggingEvent to decide upon.
  Returns:
    decision The decision of the filter.

### getLevelMax

    public Level getLevelMax()

  Get the value of the `LevelMax` option.

### getLevelMin

    public Level getLevelMin()

  Get the value of the `LevelMin` option.

### getAcceptOnMatch

    public boolean getAcceptOnMatch()

  Get the value of the `AcceptOnMatch` option.

### setLevelMax

    public void setLevelMax(Level levelMax)

  Set the `LevelMax` option.

### setLevelMin

    public void setLevelMin(Level levelMin)

  Set the `LevelMin` option.

### setAcceptOnMatch

    public void setAcceptOnMatch(boolean acceptOnMatch)

  Set the `AcceptOnMatch` option.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.