Home | History | Annotate | Download | only in io
      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 
     18 package java.io;
     19 
     20 /**
     21  * An interface for filtering {@link File} objects based on their names
     22  * or the directory they reside in.
     23  *
     24  * @see File
     25  * @see File#list(FilenameFilter)
     26  */
     27 public interface FilenameFilter {
     28 
     29     /**
     30      * Indicates if a specific filename matches this filter.
     31      *
     32      * @param dir
     33      *            the directory in which the {@code filename} was found.
     34      * @param filename
     35      *            the name of the file in {@code dir} to test.
     36      * @return  {@code true} if the filename matches the filter
     37      *            and can be included in the list, {@code false}
     38      *            otherwise.
     39      */
     40     public abstract boolean accept(File dir, String filename);
     41 }
     42