org.apache.commons.io.filefilter.IOFileFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-io Show documentation

The Apache Commons IO library contains utility classes, stream implementations, file filters, file comparators, endian transformation classes, and much more.

There is a newer version: 20030203.000550

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.io.filefilter;

import java.io.File;
import java.io.FileFilter;
import java.io.FilenameFilter;

/**
 * An interface which brings the FileFilter and FilenameFilter
 * interfaces together.
 *
 * @since 1.0
 *
 */
public interface IOFileFilter extends FileFilter, FilenameFilter {

    /**
     * An empty String array.
     */
    String[] EMPTY_STRING_ARRAY = new String[0];

    /**
     * Checks to see if the File should be accepted by this filter.
     * 
     * Defined in {@link java.io.FileFilter}.
     *
     * @param file  the File to check
     * @return true if this file matches the test
     */
    @Override
    boolean accept(File file);

    /**
     * Checks to see if the File should be accepted by this filter.
     * 
     * Defined in {@link java.io.FilenameFilter}.
     *
     * @param dir  the directory File to check
     * @param name  the file name within the directory to check
     * @return true if this file matches the test
     */
    @Override
    boolean accept(File dir, String name);

}