org.apache.commons.io.filefilter

Class NameFileFilter

Implemented Interfaces:
FileFilter, FilenameFilter, IOFileFilter

public class NameFileFilter
extends AbstractFileFilter

Filters filenames for a certain name.

For example, to print all files and directories in the current directory whose name is Test:

 File dir = new File(".");
 String[] files = dir.list( new NameFileFilter("Test") );
 for ( int i = 0; i < files.length; i++ ) {
     System.out.println(files[i]);
 }
 
Version:
$Revision: 1.3 $ $Date: 2004/02/23 04:37:57 $
Authors:
Henri Yandell
Stephen Colebourne
Federico Barbieri
Serge Knystautas
Peter Donald
Since:
Commons IO 1.0

Field Summary

private String[]
names
The filenames to search for

Constructor Summary

NameFileFilter(List names)
Constructs a new name file filter for a list of names.
NameFileFilter(String name)
Constructs a new name file filter for a single name.
NameFileFilter(String[] names)
Constructs a new name file filter for any of an array of names.

Method Summary

boolean
accept(File file)
Checks to see if the filename matches.
boolean
accept(File file, String name)
Checks to see if the filename matches.

Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter

accept, accept

Field Details

names

private String[] names
The filenames to search for

Constructor Details

NameFileFilter

public NameFileFilter(List names)
Constructs a new name file filter for a list of names.
Parameters:
names - the names to allow, must not be null

NameFileFilter

public NameFileFilter(String name)
Constructs a new name file filter for a single name.
Parameters:
name - the name to allow, must not be null

NameFileFilter

public NameFileFilter(String[] names)
Constructs a new name file filter for any of an array of names.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters:
names - the names to allow, must not be null

Method Details

accept

public boolean accept(File file)
Checks to see if the filename matches.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface AbstractFileFilter
Parameters:
file - the File to check
Returns:
true if the filename matches

accept

public boolean accept(File file,
                      String name)
Checks to see if the filename matches.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface AbstractFileFilter
Parameters:
file - the File directory
name - the filename
Returns:
true if the filename matches