blob: 39b54327f532d315b069c9e3f835551ce0778787 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1994-1998 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package java.io;
27
28/**
29 * Instances of classes that implement this interface are used to
30 * filter filenames. These instances are used to filter directory
31 * listings in the <code>list</code> method of class
32 * <code>File</code>, and by the Abstract Window Toolkit's file
33 * dialog component.
34 *
35 * @author Arthur van Hoff
36 * @author Jonathan Payne
37 * @see java.awt.FileDialog#setFilenameFilter(java.io.FilenameFilter)
38 * @see java.io.File
39 * @see java.io.File#list(java.io.FilenameFilter)
40 * @since JDK1.0
41 */
42public
43interface FilenameFilter {
44 /**
45 * Tests if a specified file should be included in a file list.
46 *
47 * @param dir the directory in which the file was found.
48 * @param name the name of the file.
49 * @return <code>true</code> if and only if the name should be
50 * included in the file list; <code>false</code> otherwise.
51 */
52 boolean accept(File dir, String name);
53}