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.LogEvent; 21 22 /** 23 * Interface implemented by Classes that allow filtering to occur. 24 */ 25 public interface Filterable { 26 27 /** 28 * Adds a new Filter. If a Filter already exists it is converted to a CompositeFilter. 29 * @param filter The Filter to add. 30 */ 31 void addFilter(Filter filter); 32 33 /** 34 * Removes a Filter. 35 * @param filter The Filter to remove. 36 */ 37 void removeFilter(Filter filter); 38 39 /** 40 * Returns an Iterator for all the Filters. 41 * @return an Iterator for all the Filters. 42 */ 43 Filter getFilter(); 44 45 /** 46 * Determine if a Filter is present. 47 * @return true if a Filter is present, false otherwise. 48 */ 49 boolean hasFilter(); 50 51 /** 52 * Determines if the event should be filtered. 53 * @param event The LogEvent. 54 * @return true if the event should be filtered, false otherwise. 55 */ 56 boolean isFiltered(LogEvent event); 57 }