001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.filter;
018
019import org.apache.logging.log4j.core.Filter;
020import org.apache.logging.log4j.core.LogEvent;
021
022/**
023 * Interface implemented by Classes that allow filtering to occur.
024 */
025public interface Filterable {
026
027    /**
028     * Adds a new Filter. If a Filter already exists it is converted to a CompositeFilter.
029     * @param filter The Filter to add.
030     */
031    void addFilter(Filter filter);
032
033    /**
034     * Removes a Filter.
035     * @param filter The Filter to remove.
036     */
037    void removeFilter(Filter filter);
038
039    /**
040     * Returns an Iterator for all the Filters.
041     * @return an Iterator for all the Filters.
042     */
043    Filter getFilter();
044
045    /**
046     * Determine if a Filter is present.
047     * @return true if a Filter is present, false otherwise.
048     */
049    boolean hasFilter();
050
051    /**
052     * Determines if the event should be filtered.
053     * @param event The LogEvent.
054     * @return true if the event should be filtered, false otherwise.
055     */
056    boolean isFiltered(LogEvent event);
057}