Class LevelRangeFilter
- All Implemented Interfaces:
org.apache.log4j.spi.OptionHandler
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
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.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) boolean
Do we return ACCEPT when a match occurs.(package private) org.apache.log4j.Level
(package private) org.apache.log4j.Level
Fields inherited from class org.apache.log4j.spi.Filter
ACCEPT, DENY, NEUTRAL, next
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
decide
(org.apache.log4j.spi.LoggingEvent event) Return the decision of this filter.boolean
Get the value of theAcceptOnMatch
option.org.apache.log4j.Level
Get the value of theLevelMax
option.org.apache.log4j.Level
Get the value of theLevelMin
option.void
setAcceptOnMatch
(boolean acceptOnMatch) Set theAcceptOnMatch
option.void
setLevelMax
(org.apache.log4j.Level levelMax) Set theLevelMax
option.void
setLevelMin
(org.apache.log4j.Level levelMin) Set theLevelMin
option.Methods inherited from class org.apache.log4j.spi.Filter
activateOptions, getNext, setNext
-
Field Details
-
acceptOnMatch
boolean acceptOnMatchDo we return ACCEPT when a match occurs. Default isfalse
, so that later filters get run by default -
levelMin
org.apache.log4j.Level levelMin -
levelMax
org.apache.log4j.Level levelMax
-
-
Constructor Details
-
LevelRangeFilter
public LevelRangeFilter()
-
-
Method Details
-
decide
public int decide(org.apache.log4j.spi.LoggingEvent event) Return the decision of this filter.- Specified by:
decide
in classorg.apache.log4j.spi.Filter
-
getLevelMax
public org.apache.log4j.Level getLevelMax()Get the value of theLevelMax
option. -
getLevelMin
public org.apache.log4j.Level getLevelMin()Get the value of theLevelMin
option. -
getAcceptOnMatch
public boolean getAcceptOnMatch()Get the value of theAcceptOnMatch
option. -
setLevelMax
public void setLevelMax(org.apache.log4j.Level levelMax) Set theLevelMax
option. -
setLevelMin
public void setLevelMin(org.apache.log4j.Level levelMin) Set theLevelMin
option. -
setAcceptOnMatch
public void setAcceptOnMatch(boolean acceptOnMatch) Set theAcceptOnMatch
option.
-