Package org.apache.log4j.spi
Class Filter
- java.lang.Object
-
- org.apache.log4j.spi.Filter
-
- Direct Known Subclasses:
FilterWrapper
public abstract class Filter extends Object
- Since:
- 0.9.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
ACCEPT
The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.static int
DENY
The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.static int
NEUTRAL
This filter is neutral with respect to the log event.Filter
next
Deprecated.As of 1.2.12, usegetNext()
andsetNext(org.apache.log4j.spi.Filter)
instead
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
activateOptions()
Usually filters options become active when set.abstract int
decide(LoggingEvent event)
If the decision isDENY
, then the event will be dropped.Filter
getNext()
Return the pointer to the next filter.void
setNext(Filter next)
Set the next filter pointer.
-
-
-
Field Detail
-
DENY
public static final int DENY
The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.- See Also:
- Constant Field Values
-
NEUTRAL
public static final int NEUTRAL
This filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision.- See Also:
- Constant Field Values
-
ACCEPT
public static final int ACCEPT
The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.- See Also:
- Constant Field Values
-
next
@Deprecated public Filter next
Deprecated.As of 1.2.12, usegetNext()
andsetNext(org.apache.log4j.spi.Filter)
insteadPoints to the next filter in the filter chain.
-
-
Method Detail
-
activateOptions
public void activateOptions()
Usually filters options become active when set. We provide a default do-nothing implementation for convenience.
-
decide
public abstract int decide(LoggingEvent event)
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
public void setNext(Filter next)
Set the next filter pointer.- Parameters:
next
- The next Filter.
-
getNext
public Filter getNext()
Return the pointer to the next filter.- Returns:
- The next Filter.
-
-