Log4j 1.2rc1

org.apache.log4j.varia
Class LevelMatchFilter

java.lang.Object
  |
  +--org.apache.log4j.spi.Filter
        |
        +--org.apache.log4j.varia.LevelMatchFilter
All Implemented Interfaces:
OptionHandler

public class LevelMatchFilter
extends Filter

This is a very simple filter based on level matching.

The filter admits two options LevelToMatch and AcceptOnMatch. If there is an exact match between the value of the LevelToMatch option and the level of the LoggingEvent, then the decide(org.apache.log4j.spi.LoggingEvent) method returns Filter.ACCEPT in case the AcceptOnMatch option value is set to true, if it is false then Filter.DENY is returned. If there is no match, Filter.NEUTRAL is returned.

Since:
1.2
Author:
Ceki Gülcü

Field Summary
static String ACCEPT_ON_MATCH_OPTION
          Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
static String LEVEL_TO_MATCH_OPTION
          Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
 
Fields inherited from class org.apache.log4j.spi.Filter
ACCEPT, DENY, NEUTRAL, next
 
Constructor Summary
LevelMatchFilter()
           
 
Method Summary
 int decide(LoggingEvent event)
          Return the decision of this filter.
 boolean getAcceptOnMatch()
           
 String getLevelToMatch()
           
 void setAcceptOnMatch(boolean acceptOnMatch)
           
 void setLevelToMatch(String level)
           
 
Methods inherited from class org.apache.log4j.spi.Filter
activateOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LEVEL_TO_MATCH_OPTION

public static final String LEVEL_TO_MATCH_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.


ACCEPT_ON_MATCH_OPTION

public static final String ACCEPT_ON_MATCH_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.

Constructor Detail

LevelMatchFilter

public LevelMatchFilter()
Method Detail

setLevelToMatch

public void setLevelToMatch(String level)

getLevelToMatch

public String getLevelToMatch()

setAcceptOnMatch

public void setAcceptOnMatch(boolean acceptOnMatch)

getAcceptOnMatch

public boolean getAcceptOnMatch()

decide

public int decide(LoggingEvent event)
Return the decision of this filter. Returns Filter.NEUTRAL if the LevelToMatch option is not set or if there is not match. Otherwise, if there is a match, then the returned decision is Filter.ACCEPT if the AcceptOnMatch property is set to true. The returned decision is Filter.DENY if the AcceptOnMatch property is set to false.
Overrides:
decide in class Filter
Following copied from class: org.apache.log4j.spi.Filter
Parameters:
event - The LoggingEvent to decide upon.
decision - The decision of the filter.

Log4j 1.2rc1

Copyright 2000-2002 Apache Software Foundation.