Package org.apache.commons.io.filefilter
Class SuffixFileFilter
java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.SuffixFileFilter
- All Implemented Interfaces:
FileFilter
,FilenameFilter
,Serializable
,IOFileFilter
Filters files based on the suffix (what the file name ends with).
This is used in retrieving all the files of a particular type.
For example, to retrieve and print all *.java
files
in the current directory:
File dir = new File("."); String[] files = dir.list( new SuffixFileFilter(".java") ); for (int i = 0; i < files.length; i++) { System.out.println(files[i]); }
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final IOCase
Whether the comparison is case sensitive.private static final long
private final String[]
The file name suffixes to search forFields inherited from interface org.apache.commons.io.filefilter.IOFileFilter
EMPTY_STRING_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionSuffixFileFilter
(String suffix) Constructs a new Suffix file filter for a single extension.SuffixFileFilter
(String... suffixes) Constructs a new Suffix file filter for an array of suffixes.SuffixFileFilter
(String[] suffixes, IOCase caseSensitivity) Constructs a new Suffix file filter for an array of suffixes specifying case-sensitivity.SuffixFileFilter
(String suffix, IOCase caseSensitivity) Constructs a new Suffix file filter for a single extension specifying case-sensitivity.SuffixFileFilter
(List<String> suffixes) Constructs a new Suffix file filter for a list of suffixes.SuffixFileFilter
(List<String> suffixes, IOCase caseSensitivity) Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity. -
Method Summary
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
suffixes
The file name suffixes to search for -
caseSensitivity
Whether the comparison is case sensitive.
-
-
Constructor Details
-
SuffixFileFilter
Constructs a new Suffix file filter for a single extension.- Parameters:
suffix
- the suffix to allow, must not be null- Throws:
IllegalArgumentException
- if the suffix is null
-
SuffixFileFilter
Constructs a new Suffix file filter for a single extension specifying case-sensitivity.- Parameters:
suffix
- the suffix to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the suffix is null- Since:
- 1.4
-
SuffixFileFilter
Constructs a new Suffix file filter for an array of suffixes.The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.
- Parameters:
suffixes
- the suffixes to allow, must not be null- Throws:
IllegalArgumentException
- if the suffix array is null
-
SuffixFileFilter
Constructs a new Suffix file filter for an array of suffixes specifying case-sensitivity.- Parameters:
suffixes
- the suffixes to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the suffix array is null- Since:
- 1.4
-
SuffixFileFilter
Constructs a new Suffix file filter for a list of suffixes.- Parameters:
suffixes
- the suffixes to allow, must not be null- Throws:
IllegalArgumentException
- if the suffix list is nullClassCastException
- if the list does not contain Strings
-
SuffixFileFilter
Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.- Parameters:
suffixes
- the suffixes to allow, must not be nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive- Throws:
IllegalArgumentException
- if the suffix list is nullClassCastException
- if the list does not contain Strings- Since:
- 1.4
-
-
Method Details
-
accept
Checks to see if the file name ends with the suffix.- 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 ends with one of our suffixes
-
accept
Checks to see if the file name ends with the suffix.- 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 ends with one of our suffixes
-
toString
Provide a String representation of this file filter.- Overrides:
toString
in classAbstractFileFilter
- Returns:
- a String representation
-