001/**
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
004 *
005 * This program and the accompanying materials are dual-licensed under
006 * either the terms of the Eclipse Public License v1.0 as published by
007 * the Eclipse Foundation
008 *
009 *   or (per the licensee's choosing)
010 *
011 * under the terms of the GNU Lesser General Public License version 2.1
012 * as published by the Free Software Foundation.
013 */
014package ch.qos.logback.core.spi;
015
016import java.util.List;
017
018import ch.qos.logback.core.filter.Filter;
019
020/**
021 * Interface for attaching filters to objects.
022 * 
023 * @author Ceki Gülcü
024 */
025public interface FilterAttachable<E> {
026    /**
027     * Add a filter.
028     */
029    void addFilter(Filter<E> newFilter);
030
031    void clearAllFilters();
032
033    /**
034     * Get a copy of all the filters contained within this FilterAttachable
035     * object.
036     * 
037     * @return all attached filters as a list
038     */
039    List<Filter<E>> getCopyOfAttachedFiltersList();
040
041    /**
042     * Loop through the filters in the chain. As soon as a filter decides on
043     * ACCEPT or DENY, then that value is returned. If all of the filters return
044     * NEUTRAL, then NEUTRAL is returned.
045     */
046    FilterReply getFilterChainDecision(E event);
047}