org.apache.log4j.varia

Class StringMatchFilter

public class StringMatchFilter extends Filter

This is a very simple filter based on string matching.

The filter admits two options StringToMatch and AcceptOnMatch. If there is a match between the value of the StringToMatch option and the message of the {@link org.apache.log4j.spi.LoggingEvent}, then the {@link #decide(LoggingEvent)} method returns {@link org.apache.log4j.spi.Filter#ACCEPT} if the AcceptOnMatch option value is true, if it is false then {@link org.apache.log4j.spi.Filter#DENY} is returned. If there is no match, {@link org.apache.log4j.spi.Filter#NEUTRAL} is returned.

Since: 0.9.0

Author: Ceki Gülcü

Field Summary
static StringACCEPT_ON_MATCH_OPTION
static StringSTRING_TO_MATCH_OPTION
Method Summary
intdecide(LoggingEvent event)
Returns {@link Filter#NEUTRAL} is there is no string match.
booleangetAcceptOnMatch()
String[]getOptionStrings()
StringgetStringToMatch()
voidsetAcceptOnMatch(boolean acceptOnMatch)
voidsetOption(String key, String value)
voidsetStringToMatch(String s)

Field Detail

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.

STRING_TO_MATCH_OPTION

public static final String STRING_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.

Method Detail

decide

public int decide(LoggingEvent event)
Returns {@link Filter#NEUTRAL} is there is no string match.

getAcceptOnMatch

public boolean getAcceptOnMatch()

getOptionStrings

public String[] getOptionStrings()

Deprecated: We now use JavaBeans introspection to configure components. Options strings are no longer needed.

getStringToMatch

public String getStringToMatch()

setAcceptOnMatch

public void setAcceptOnMatch(boolean acceptOnMatch)

setOption

public void setOption(String key, String value)

Deprecated: Use the setter method for the option directly instead of the generic setOption method.

setStringToMatch

public void setStringToMatch(String s)
Copyright 2000-2005 Apache Software Foundation.