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, IOFileFilter
- public class SuffixFileFilter
- extends AbstractFileFilter
Filters files based on the suffix (what the filename 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]);
}
- Since:
- Commons IO 1.0
- Version:
- $Revision: 471628 $ $Date: 2006-11-05 20:06:45 -0800 (Sun, 05 Nov 2006) $
- Author:
- Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald
Field Summary |
private String[] |
suffixes
The filename suffixes to search for |
Method Summary |
boolean |
accept(File file)
Checks to see if the filename ends with the suffix. |
boolean |
accept(File file,
String name)
Checks to see if the filename ends with the suffix. |
Methods inherited from class java.lang.Object |
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait |
suffixes
private String[] suffixes
- The filename suffixes to search for
SuffixFileFilter
public SuffixFileFilter(String suffix)
- 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
public SuffixFileFilter(String[] suffixes)
- Constructs a new Suffix file filter for an array of suffixs.
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
public SuffixFileFilter(List suffixes)
- 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
accept
public boolean accept(File file)
- Checks to see if the filename ends with the suffix.
- Overrides:
accept
in class AbstractFileFilter
- Parameters:
file
- the File to check- Returns:
- true if the filename ends with one of our suffixes
accept
public boolean accept(File file,
String name)
- Checks to see if the filename ends with the suffix.
- Overrides:
accept
in class AbstractFileFilter
- Parameters:
file
- the File directoryname
- the filename- Returns:
- true if the filename ends with one of our suffixes