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.commons.io.filefilter;
18
19 import java.util.List;
20
21 /**
22 * Defines operations for conditional file filters.
23 *
24 * @since 1.1
25 */
26 public interface ConditionalFileFilter {
27
28 /**
29 * Adds the specified file filter to the list of file filters at the end of
30 * the list.
31 *
32 * @param ioFileFilter the filter to be added
33 * @since 1.1
34 */
35 void addFileFilter(IOFileFilter ioFileFilter);
36
37 /**
38 * Gets this conditional file filter's list of file filters.
39 *
40 * @return the file filter list
41 * @since 1.1
42 */
43 List<IOFileFilter> getFileFilters();
44
45 /**
46 * Removes the specified file filter.
47 *
48 * @param ioFileFilter filter to be removed
49 * @return {@code true} if the filter was found in the list,
50 * {@code false} otherwise
51 * @since 1.1
52 */
53 boolean removeFileFilter(IOFileFilter ioFileFilter);
54
55 /**
56 * Sets the list of file filters, replacing any previously configured
57 * file filters on this filter.
58 *
59 * @param fileFilters the list of filters
60 * @since 1.1
61 */
62 void setFileFilters(List<IOFileFilter> fileFilters);
63
64 }