|
Log4j 1.1.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.log4j.spi.Filter | +--org.apache.log4j.varia.PriorityMatchFilter
This is a very simple filter based on priority matching.
The filter admits two options PriorityToMatch and
AcceptOnMatch. If there is an exact match between the value
of the PriorityToMatch option and the priority 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.
See configuration files test11.xml and test12.xml for an example of
seeting up a PriorityMatchFilter
.
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 |
PRIORITY_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 | |
PriorityMatchFilter()
|
Method Summary | |
int |
decide(LoggingEvent event)
Return the decision of this filter. |
boolean |
getAcceptOnMatch()
|
String[] |
getOptionStrings()
Return list of strings that the OptionHandler instance recognizes. |
String |
getPriorityToMatch()
|
void |
setAcceptOnMatch(boolean acceptOnMatch)
|
void |
setOption(String key,
String value)
Set option to value . |
void |
setPriorityToMatch(String priority)
|
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 |
public static final String PRIORITY_TO_MATCH_OPTION
public static final String ACCEPT_ON_MATCH_OPTION
Constructor Detail |
public PriorityMatchFilter()
Method Detail |
public String[] getOptionStrings()
OptionHandler
public void setOption(String key, String value)
setOption
method.
OptionHandler
option
to value
.
The handling of each option depends on the OptionHandler
instance. Some options may become active immediately whereas
other may be activated only when OptionHandler.activateOptions()
is
called.
public void setPriorityToMatch(String priority)
public String getPriorityToMatch()
public void setAcceptOnMatch(boolean acceptOnMatch)
public boolean getAcceptOnMatch()
public int decide(LoggingEvent event)
Filter.NEUTRAL
if the PriorityToMatch
option is not set. Otherwise, the returned decision is defined
according to the following table:
Did a priority match occur? | AcceptOnMatch setting | |
---|---|---|
TRUE | FALSE | |
TRUE | Filter.ACCEPT | Filter.DENY |
FALSE | Filter.DENY | Filter.ACCEPT |
decide
in class Filter
org.apache.log4j.spi.Filter
event
- The LoggingEvent to decide upon.decision
- The decision of the filter.
|
Log4j 1.1.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |