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