FileDocCategorySizeDatePackage
LevelMatchFilter.javaAPI DocApache log4j 1.2.153055Sat Aug 25 00:09:40 BST 2007org.apache.log4j.varia

LevelMatchFilter

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 {@link LoggingEvent}, then the {@link #decide} method returns {@link Filter#ACCEPT} in case the AcceptOnMatch option value is set to true, if it is false then {@link Filter#DENY} is returned. If there is no match, {@link Filter#NEUTRAL} is returned.

author
Ceki Gülcü
since
1.2

Fields Summary
boolean
acceptOnMatch
Do we return ACCEPT when a match occurs. Default is true.
Level
levelToMatch
Constructors Summary
Methods Summary
public intdecide(org.apache.log4j.spi.LoggingEvent event)
Return the decision of this filter. Returns {@link 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 {@link Filter#ACCEPT} if the AcceptOnMatch property is set to true. The returned decision is {@link Filter#DENY} if the AcceptOnMatch property is set to false.

    if(this.levelToMatch == null) {
      return Filter.NEUTRAL;
    }
    
    boolean matchOccured = false;
    if(this.levelToMatch.equals(event.getLevel())) {
      matchOccured = true;
    } 

    if(matchOccured) {  
      if(this.acceptOnMatch)
	  return Filter.ACCEPT;
      else
	  return Filter.DENY;
    } else {
      return Filter.NEUTRAL;
    }
public booleangetAcceptOnMatch()

    return acceptOnMatch;
public java.lang.StringgetLevelToMatch()

    return levelToMatch == null ? null : levelToMatch.toString();
public voidsetAcceptOnMatch(boolean acceptOnMatch)

    this.acceptOnMatch = acceptOnMatch;
public voidsetLevelToMatch(java.lang.String level)


 
  
     
    levelToMatch = OptionConverter.toLevel(level, null);