org.apache.commons.io.filefilter

Class NameFileFilter

Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, IOFileFilter

public class NameFileFilter
extends AbstractFileFilter
implements Serializable

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: 606381 $ $Date: 2007-12-22 02:03:16 +0000 (Sat, 22 Dec 2007) $
Authors:
Stephen Colebourne
Federico Barbieri
Serge Knystautas
Peter Donald
Since:
Commons IO 1.0

Field Summary

private IOCase
caseSensitivity
Whether the comparison is case sensitive.
private String[]
names
The filenames to search for

Constructor Summary

NameFileFilter(List names)
Constructs a new case-sensitive name file filter for a list of names.
NameFileFilter(List names, IOCase caseSensitivity)
Constructs a new name file filter for a list of names specifying case-sensitivity.
NameFileFilter(String name)
Constructs a new case-sensitive name file filter for a single name.
NameFileFilter(String name, IOCase caseSensitivity)
Construct a new name file filter specifying case-sensitivity.
NameFileFilter(String[] names)
Constructs a new case-sensitive name file filter for an array of names.
NameFileFilter(String[] names, IOCase caseSensitivity)
Constructs a new name file filter for an array of names specifying case-sensitivity.

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.
String
toString()
Provide a String representaion of this file filter.

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

accept, accept, toString

Field Details

caseSensitivity

private final IOCase caseSensitivity
Whether the comparison is case sensitive.

names

private final String[] names
The filenames to search for

Constructor Details

NameFileFilter

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

NameFileFilter

public NameFileFilter(List names,
                      IOCase caseSensitivity)
Constructs a new name file filter for a list of names specifying case-sensitivity.
Parameters:
names - the names to allow, must not be null
caseSensitivity - how to handle case sensitivity, null means case-sensitive

NameFileFilter

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

NameFileFilter

public NameFileFilter(String name,
                      IOCase caseSensitivity)
Construct a new name file filter specifying case-sensitivity.
Parameters:
name - the name to allow, must not be null
caseSensitivity - how to handle case sensitivity, null means case-sensitive

NameFileFilter

public NameFileFilter(String[] names)
Constructs a new case-sensitive name file filter for 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

NameFileFilter

public NameFileFilter(String[] names,
                      IOCase caseSensitivity)
Constructs a new name file filter for an array of names specifying case-sensitivity.

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
caseSensitivity - how to handle case sensitivity, null means case-sensitive

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

toString

public String toString()
Provide a String representaion of this file filter.
Overrides:
toString in interface AbstractFileFilter
Returns:
a String representaion

Copyright (c) 2002-2008 Apache Software Foundation