ch.qos.logback.core.spi
Interface FilterAttachable<E>

All Known Subinterfaces:
Appender<E>
All Known Implementing Classes:
AppenderBase, ConsoleAppender, CyclicBufferAppender, DBAppender, DBAppenderBase, FileAppender, FilterAttachableImpl, JMSAppenderBase, JMSQueueAppender, JMSTopicAppender, ListAppender, RollingFileAppender, SiftingAppender, SiftingAppenderBase, SMTPAppender, SMTPAppenderBase, SocketAppender, SocketAppenderBase, SyslogAppender, SyslogAppenderBase, TelnetAppender, UnsynchronizedAppenderBase, WriterAppender

public interface FilterAttachable<E>

Interface for attaching filters to objects.

Author:
Ceki Gülcü

Method Summary
 void addFilter(Filter<E> newFilter)
          Add a filter.
 void clearAllFilters()
           
 java.util.List<Filter<E>> getCopyOfAttachedFiltersList()
          Get a copy of all the filters contained within this FilterAttachable object.
 FilterReply getFilterChainDecision(E event)
          Loop through the filters in the chain.
 Filter getFirstFilter()
          Deprecated. This method will be removed in future versions. Please use getCopyOfAttachedFiltersList() method instead.
 

Method Detail

addFilter

void addFilter(Filter<E> newFilter)
Add a filter.


getFirstFilter

Filter getFirstFilter()
Deprecated. This method will be removed in future versions. Please use getCopyOfAttachedFiltersList() method instead.

Get first filter in the chain.


clearAllFilters

void clearAllFilters()

getCopyOfAttachedFiltersList

java.util.List<Filter<E>> getCopyOfAttachedFiltersList()
Get a copy of all the filters contained within this FilterAttachable object.

Returns:
all attached filters as a list

getFilterChainDecision

FilterReply getFilterChainDecision(E event)
Loop through the filters in the chain. As soon as a filter decides on ACCEPT or DENY, then that value is returned. If all of the filters return NEUTRAL, then NEUTRAL is returned.