/*

 * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.swing.filechooser;

import java.io.File;

/**

 * <code>FileFilter</code> is an abstract class used by {@code JFileChooser}

 * for filtering the set of files shown to the user. See

 * {@code FileNameExtensionFilter} for an implementation that filters using

 * the file name extension.

 * <p>

 * A <code>FileFilter</code>

 * can be set on a <code>JFileChooser</code> to

 * keep unwanted files from appearing in the directory listing.

 * For an example implementation of a simple file filter, see

 * <code><i>yourJDK</i>/demo/jfc/FileChooserDemo/ExampleFileFilter.java</code>.

 * For more information and examples see

 * <a href="https://docs.oracle.com/javase/tutorial/uiswing/components/filechooser.html">How to Use File Choosers</a>,

 * a section in <em>The Java Tutorial</em>.

 *

 * @see FileNameExtensionFilter

 * @see javax.swing.JFileChooser#setFileFilter

 * @see javax.swing.JFileChooser#addChoosableFileFilter

 *

 * @author Jeff Dinkins

 */

public abstract class FileFilter {

    /**

     * Whether the given file is accepted by this filter.

     */

    public abstract boolean accept(File f);

    /**

     * The description of this filter. For example: "JPG and GIF Images"

     * @see FileView#getName

     */

    public abstract String getDescription();

}