1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.filter;
18
19 import org.apache.logging.log4j.core.Filter;
20 import org.apache.logging.log4j.core.LifeCycle;
21 import org.apache.logging.log4j.core.LogEvent;
22
23 /**
24 * Interface implemented by Classes that allow filtering to occur.
25 *
26 * <p>
27 * Extends {@link LifeCycle} since filters have a life cycle.
28 * </p>
29 */
30 public interface Filterable extends LifeCycle {
31
32 /**
33 * Adds a new Filter. If a Filter already exists it is converted to a CompositeFilter.
34 * @param filter The Filter to add.
35 */
36 void addFilter(Filter filter);
37
38 /**
39 * Removes a Filter.
40 * @param filter The Filter to remove.
41 */
42 void removeFilter(Filter filter);
43
44 /**
45 * Returns an Iterator for all the Filters.
46 * @return an Iterator for all the Filters.
47 */
48 Filter getFilter();
49
50 /**
51 * Determine if a Filter is present.
52 * @return true if a Filter is present, false otherwise.
53 */
54 boolean hasFilter();
55
56 /**
57 * Determines if the event should be filtered.
58 * @param event The LogEvent.
59 * @return true if the event should be filtered, false otherwise.
60 */
61 boolean isFiltered(LogEvent event);
62 }