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.commons.vfs2.filter; 018 019import java.util.List; 020 021import org.apache.commons.vfs2.FileFilter; 022 023/** 024 * Defines operations for conditional file filters. 025 * 026 * @author This code was originally ported from Apache Commons IO File Filter 027 * @see "https://commons.apache.org/proper/commons-io/" 028 * @since 2.4 029 */ 030public interface ConditionalFileFilter { 031 032 /** 033 * Adds the specified file filter to the list of file filters at the end of the 034 * list. 035 * 036 * @param fileFilter the filter to be added 037 */ 038 void addFileFilter(FileFilter fileFilter); 039 040 /** 041 * Returns this conditional file filter's list of file filters. 042 * 043 * @return the file filter list 044 */ 045 List<FileFilter> getFileFilters(); 046 047 /** 048 * Removes the specified file filter. 049 * 050 * @param fileFilter filter to be removed 051 * @return {@code true} if the filter was found in the list, {@code false} 052 * otherwise 053 */ 054 boolean removeFileFilter(FileFilter fileFilter); 055 056 /** 057 * Sets the list of file filters, replacing any previously configured file 058 * filters on this filter. 059 * 060 * @param fileFilters the list of filters 061 */ 062 void setFileFilters(List<FileFilter> fileFilters); 063 064}