Package org.apache.log4j.varia
Class StringMatchFilter
- java.lang.Object
-
- org.apache.log4j.spi.Filter
-
- org.apache.log4j.varia.StringMatchFilter
-
- All 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 thedecide(LoggingEvent)
method returnsFilter.ACCEPT
if the AcceptOnMatch option value is true, if it is false thenFilter.DENY
is returned. If there is no match,Filter.NEUTRAL
is returned.- Since:
- 0.9.0
- Author:
- Ceki Gülcü
-
-
Field Summary
Fields Modifier and Type Field Description 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.
-
Constructor Summary
Constructors Constructor Description StringMatchFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
decide(LoggingEvent event)
ReturnsFilter.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 genericsetOption
method.void
setStringToMatch(String s)
-
Methods inherited from class org.apache.log4j.spi.Filter
activateOptions, getNext, setNext
-
-
-
-
Field Detail
-
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.- See Also:
- Constant Field Values
-
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.- See Also:
- Constant Field Values
-
-
Method Detail
-
getOptionStrings
public String[] getOptionStrings()
Deprecated.We now use JavaBeans introspection to configure components. Options strings are no longer needed.
-
setOption
public void setOption(String key, String value)
Deprecated.Use the setter method for the option directly instead of the genericsetOption
method.
-
setStringToMatch
public void setStringToMatch(String s)
-
getStringToMatch
public String getStringToMatch()
-
setAcceptOnMatch
public void setAcceptOnMatch(boolean acceptOnMatch)
-
getAcceptOnMatch
public boolean getAcceptOnMatch()
-
decide
public int decide(LoggingEvent event)
ReturnsFilter.NEUTRAL
is there is no string match.
-
-