| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ConditionalFileFilter |
|
| 1.0;1 |
| 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 | * @version $Id: ConditionalFileFilter.java 1307462 2012-03-30 15:13:11Z ggregory $ | |
| 26 | */ | |
| 27 | public interface ConditionalFileFilter { | |
| 28 | ||
| 29 | /** | |
| 30 | * Adds the specified file filter to the list of file filters at the end of | |
| 31 | * the list. | |
| 32 | * | |
| 33 | * @param ioFileFilter the filter to be added | |
| 34 | * @since 1.1 | |
| 35 | */ | |
| 36 | void addFileFilter(IOFileFilter ioFileFilter); | |
| 37 | ||
| 38 | /** | |
| 39 | * Returns this conditional file filter's list of file filters. | |
| 40 | * | |
| 41 | * @return the file filter list | |
| 42 | * @since 1.1 | |
| 43 | */ | |
| 44 | List<IOFileFilter> getFileFilters(); | |
| 45 | ||
| 46 | /** | |
| 47 | * Removes the specified file filter. | |
| 48 | * | |
| 49 | * @param ioFileFilter filter to be removed | |
| 50 | * @return {@code true} if the filter was found in the list, | |
| 51 | * {@code false} otherwise | |
| 52 | * @since 1.1 | |
| 53 | */ | |
| 54 | boolean removeFileFilter(IOFileFilter ioFileFilter); | |
| 55 | ||
| 56 | /** | |
| 57 | * Sets the list of file filters, replacing any previously configured | |
| 58 | * file filters on this filter. | |
| 59 | * | |
| 60 | * @param fileFilters the list of filters | |
| 61 | * @since 1.1 | |
| 62 | */ | |
| 63 | void setFileFilters(List<IOFileFilter> fileFilters); | |
| 64 | ||
| 65 | } |