Package org.apache.commons.io.filefilter
Class NameFileFilter
java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.NameFileFilter
- All Implemented Interfaces:
FileFilter
,FilenameFilter
,Serializable
,IOFileFilter
Filters file names 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]); }
-
Field Summary
Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilter
EMPTY_STRING_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionNameFileFilter
(String name) Constructs a new case-sensitive name file filter for a single name.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.NameFileFilter
(String name, IOCase caseSensitivity) Construct a new name file filter specifying case-sensitivity.NameFileFilter
(List<String> names) Constructs a new case-sensitive name file filter for a list of names.NameFileFilter
(List<String> names, IOCase caseSensitivity) Constructs a new name file filter for a list of names specifying case-sensitivity. -
Method Summary
-
Constructor Details
-
NameFileFilter
Constructs a new case-sensitive name file filter for a single name.- Parameters:
name
- the name to allow, must not be null- Throws:
IllegalArgumentException
- if the name is null
-
NameFileFilter
Construct a new name file filter specifying case-sensitivity.- Parameters:
name
- the name to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the name is null
-
NameFileFilter
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- Throws:
IllegalArgumentException
- if the names array is null
-
NameFileFilter
Constructs a new name file filter for an array of names specifying case-sensitivity.- Parameters:
names
- the names to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the names array is null
-
NameFileFilter
Constructs a new case-sensitive name file filter for a list of names.- Parameters:
names
- the names to allow, must not be null- Throws:
IllegalArgumentException
- if the name list is nullClassCastException
- if the list does not contain Strings
-
NameFileFilter
Constructs a new name file filter for a list of names specifying case-sensitivity.- Parameters:
names
- the names to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the name list is nullClassCastException
- if the list does not contain Strings
-
-
Method Details
-
accept
Checks to see if the file name matches.- Specified by:
accept
in interfaceFileFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
file
- the File to check- Returns:
- true if the file name matches
-
accept
Checks to see if the file name matches.- Specified by:
accept
in interfaceFilenameFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
dir
- the File directory (ignored)name
- the file name- Returns:
- true if the file name matches
-
toString
Provide a String representation of this file filter.- Overrides:
toString
in classAbstractFileFilter
- Returns:
- a String representation
-