Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.log4j.spi
Class Filter

    java.lang.Object
      org.apache.log4j.spi.Filter

    public abstract class Filter

extends Object

Since:
  0.9.0

Field Summary
`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, use `getNext()` and `setNext(org.apache.log4j.spi.Filter)` instead

Constructor Summary
`Filter()`

Method Summary
`void` | `activateOptions()` Usually filters options become active when set.
`abstract int` | `decide(LoggingEvent event)` If the decision is `DENY`, then the event will be dropped.
`Filter` | `getNext()` Return the pointer to the next filter.
`void` | `setNext(Filter next)` Set the next filter pointer.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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, use `getNext()` and `setNext(org.apache.log4j.spi.Filter)` instead
  Points to the next filter in the filter chain.

Constructor Detail

### Filter

    public Filter()

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 is `NEUTRAL`, 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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.