Top Description Fields Constructors Methods
org.apache.commons.io.filefilter

public Class NameFileFilter

extends AbstractFileFilter
Class Inheritance
Imports
java.io.File, java.util.List, org.apache.commons.io.IOCase
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]);
}
Authors
Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald
Since
Commons IO 1.0
Version
$Revision: 471628 $ $Date: 2006-11-06 05:06:45 +0100 (Mo, 06 Nov 2006) $

Field Summary

Modifier and TypeField and Description
private IOCase
caseSensitivity

Whether the comparison is case sensitive.

private String[]
names

The filenames to search for

Constructor Summary

AccessConstructor and Description
public
NameFileFilter(String
the name to allow, must not be null
name)

Constructs a new case-sensitive name file filter for a single name.

public
NameFileFilter(String
the name to allow, must not be null
name, IOCase
how to handle case sensitivity, null means case-sensitive
caseSensitivity)

Construct a new name file filter specifying case-sensitivity.

public
NameFileFilter(String[]
the names to allow, must not be null
names)

Constructs a new case-sensitive name file filter for an array of names.

public
NameFileFilter(String[]
the names to allow, must not be null
names, IOCase
how to handle case sensitivity, null means case-sensitive
caseSensitivity)

Constructs a new name file filter for an array of names specifying case-sensitivity.

public
NameFileFilter(List<E>
the names to allow, must not be null
names)

Constructs a new case-sensitive name file filter for a list of names.

public
NameFileFilter(List<E>
the names to allow, must not be null
names, IOCase
how to handle case sensitivity, null means case-sensitive
caseSensitivity)

Constructs a new name file filter for a list of names specifying case-sensitivity.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the filename matches
accept(File
the File to check
file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches.
public boolean

Returns:

true if the filename matches
accept(File
the File directory
file, String
the filename
name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches.

Field Detail

caseSensitivityback to summary
private IOCase caseSensitivity

Whether the comparison is case sensitive.

namesback to summary
private String[] names

The filenames to search for

Constructor Detail

NameFileFilterback to summary
public NameFileFilter(String name)

Constructs a new case-sensitive name file filter for a single name.

Parameters
name:String

the name to allow, must not be null

Exceptions
IllegalArgumentException:
if the name is null
NameFileFilterback to summary
public NameFileFilter(String name, IOCase caseSensitivity)

Construct a new name file filter specifying case-sensitivity.

Parameters
name:String

the name to allow, must not be null

caseSensitivity:IOCase

how to handle case sensitivity, null means case-sensitive

Exceptions
IllegalArgumentException:
if the name is null
NameFileFilterback to summary
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:String[]

the names to allow, must not be null

Exceptions
IllegalArgumentException:
if the names array is null
NameFileFilterback to summary
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:String[]

the names to allow, must not be null

caseSensitivity:IOCase

how to handle case sensitivity, null means case-sensitive

Exceptions
IllegalArgumentException:
if the names array is null
NameFileFilterback to summary
public NameFileFilter(List<E> names)

Constructs a new case-sensitive name file filter for a list of names.

Parameters
names:List<E>

the names to allow, must not be null

Exceptions
IllegalArgumentException:
if the name list is null
ClassCastException:
if the list does not contain Strings
NameFileFilterback to summary
public NameFileFilter(List<E> names, IOCase caseSensitivity)

Constructs a new name file filter for a list of names specifying case-sensitivity.

Parameters
names:List<E>

the names to allow, must not be null

caseSensitivity:IOCase

how to handle case sensitivity, null means case-sensitive

Exceptions
IllegalArgumentException:
if the name list is null
ClassCastException:
if the list does not contain Strings

Method Detail

acceptback to summary
public boolean accept(File file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches.

Parameters
file:File

the File to check

Returns:boolean

true if the filename matches

acceptback to summary
public boolean accept(File file, String name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches.

Parameters
file:File

the File directory

name:String

the filename

Returns:boolean

true if the filename matches