Package org.apache.log4j.spi
Class Filter
java.lang.Object
org.apache.log4j.spi.Filter
- Direct Known Subclasses:
DenyAllFilter
,FilterWrapper
,LevelMatchFilter
,LevelRangeFilter
,StringMatchFilter
- Since:
- 0.9.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.static final int
The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.private static final boolean
static final int
This filter is neutral with respect to the log event.Deprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Usually filters options become active when set.abstract int
decide
(LoggingEvent event) If the decision isDENY
, then the event will be dropped.getNext()
Return the pointer to the next filter.void
Set the next filter pointer.
-
Field Details
-
DENY
public static final int DENYThe log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.- See Also:
-
NEUTRAL
public static final int NEUTRALThis filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision.- See Also:
-
ACCEPT
public static final int ACCEPTThe log event must be logged immediately without consulting with the remaining filters, if any, in the chain.- See Also:
-
next
Deprecated.As of 1.2.12, usegetNext()
andsetNext(org.apache.log4j.spi.Filter)
insteadPoints to the next filter in the filter chain. -
isCorePresent
private static final boolean isCorePresent
-
-
Constructor Details
-
Filter
public Filter()
-
-
Method Details
-
activateOptions
public void activateOptions()Usually filters options become active when set. We provide a default do-nothing implementation for convenience. -
decide
If the decision is
DENY
, then the event will be dropped. If the decision isNEUTRAL
, then the next filter, if any, will be invoked. If the decision is ACCEPT then the event will be logged without consulting with other filters in the chain.- Parameters:
event
- The LoggingEvent to decide upon.- Returns:
- decision The decision of the filter.
-
setNext
Set the next filter pointer.- Parameters:
next
- The next Filter.
-
getNext
Return the pointer to the next filter.- Returns:
- The next Filter.
-
getNext()
andsetNext(org.apache.log4j.spi.Filter)
instead