Overview Package Class Use Tree Index Deprecated About
Log4j 1.2.13
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.log4j.varia

Class StringMatchFilter

Implemented Interfaces:
OptionHandler
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 LoggingEvent, then the decide(LoggingEvent) method returns Filter.ACCEPT if the AcceptOnMatch option value is true, if it is false then Filter.DENY is returned. If there is no match, Filter.NEUTRAL is returned.

Author:
Ceki Gülcü
Since:
0.9.0

Field Summary

static String
ACCEPT_ON_MATCH_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm.
static String
STRING_TO_MATCH_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm.

Fields inherited from class org.apache.log4j.spi.Filter

ACCEPT, DENY, NEUTRAL, next

Method Summary

int
decide(LoggingEvent event)
Returns Filter.NEUTRAL is there is no string match.
boolean
getAcceptOnMatch()
String[]
getOptionStrings()
Deprecated. We now use JavaBeans introspection to configure components.
String
getStringToMatch()
void
setAcceptOnMatch(boolean acceptOnMatch)
void
setOption(String key, String value)
Deprecated. Use the setter method for the option directly instead of the generic setOption method.
void
setStringToMatch(String s)

Methods inherited from class org.apache.log4j.spi.Filter

activateOptions, decide, getNext, setNext

Field Details

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 Details

decide

public int decide(LoggingEvent event)
Returns Filter.NEUTRAL is there is no string match.
Overrides:
decide in interface Filter

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)

Overview Package Class Use Tree Index Deprecated About
Copyright 2000-2005 Apache Software Foundation.