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