public class

LevelRangeFilter

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

Class Overview

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 DENY is returned.

If the Logging event level is within the specified range, then if AcceptOnMatch is true, ACCEPT is returned, and if AcceptOnMatch is false, 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 AppenderSkeleton for a more convenient way to filter out events by level.

Summary

[Expand]
Inherited Constants
From class org.apache.log4j.spi.Filter
[Expand]
Inherited Fields
From class org.apache.log4j.spi.Filter
Public Constructors
LevelRangeFilter()
Public Methods
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.
[Expand]
Inherited Methods
From class org.apache.log4j.spi.Filter
From class java.lang.Object
From interface org.apache.log4j.spi.OptionHandler

Public Constructors

public LevelRangeFilter ()

Public Methods

public int decide (LoggingEvent event)

Return the decision of this filter.

Parameters
event The LoggingEvent to decide upon.
Returns
  • decision The decision of the 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.