Package org.apache.commons.io.filefilter
Class PrefixFileFilter
java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.PrefixFileFilter
- All Implemented Interfaces:
FileFilter
,FilenameFilter
,Serializable
,IOFileFilter
Filters file names for a certain prefix.
For example, to print all files and directories in the
current directory whose name starts with Test
:
File dir = new File("."); String[] files = dir.list( new PrefixFileFilter("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
ConstructorsConstructorDescriptionPrefixFileFilter
(String prefix) Constructs a new Prefix file filter for a single prefix.PrefixFileFilter
(String... prefixes) Constructs a new Prefix file filter for any of an array of prefixes.PrefixFileFilter
(String[] prefixes, IOCase caseSensitivity) Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.PrefixFileFilter
(String prefix, IOCase caseSensitivity) Constructs a new Prefix file filter for a single prefix specifying case-sensitivity.PrefixFileFilter
(List<String> prefixes) Constructs a new Prefix file filter for a list of prefixes.PrefixFileFilter
(List<String> prefixes, IOCase caseSensitivity) Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity. -
Method Summary
-
Constructor Details
-
PrefixFileFilter
Constructs a new Prefix file filter for a single prefix.- Parameters:
prefix
- the prefix to allow, must not be null- Throws:
IllegalArgumentException
- if the prefix is null
-
PrefixFileFilter
Constructs a new Prefix file filter for a single prefix specifying case-sensitivity.- Parameters:
prefix
- the prefix to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the prefix is null- Since:
- 1.4
-
PrefixFileFilter
Constructs a new Prefix file filter for any of an array of prefixes.The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.
- Parameters:
prefixes
- the prefixes to allow, must not be null- Throws:
IllegalArgumentException
- if the prefix array is null
-
PrefixFileFilter
Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.- Parameters:
prefixes
- the prefixes to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the prefix is null- Since:
- 1.4
-
PrefixFileFilter
Constructs a new Prefix file filter for a list of prefixes.- Parameters:
prefixes
- the prefixes to allow, must not be null- Throws:
IllegalArgumentException
- if the prefix list is nullClassCastException
- if the list does not contain Strings
-
PrefixFileFilter
Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity.- Parameters:
prefixes
- the prefixes to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the prefix list is nullClassCastException
- if the list does not contain Strings- Since:
- 1.4
-
-
Method Details
-
accept
Checks to see if the file name starts with the prefix.- 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 starts with one of our prefixes
-
accept
Checks to see if the file name starts with the prefix.- Specified by:
accept
in interfaceFilenameFilter
- Specified by:
accept
in interfaceIOFileFilter
- Overrides:
accept
in classAbstractFileFilter
- Parameters:
file
- the File directoryname
- the file name- Returns:
- true if the file name starts with one of our prefixes
-
toString
Provide a String representation of this file filter.- Overrides:
toString
in classAbstractFileFilter
- Returns:
- a String representation
-