org.apache.commons.io.filefilter

Class SuffixFileFilter

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-06 05:06:45 +0100 (Mo, 06 Nov 2006) $

Author: Stephen Colebourne Federico Barbieri Serge Knystautas Peter Donald

Field Summary
String[]suffixes
The filename suffixes to search for
Constructor Summary
SuffixFileFilter(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 suffixs.
SuffixFileFilter(List suffixes)
Constructs a new Suffix file filter for a list of suffixes.
Method Summary
booleanaccept(File file)
Checks to see if the filename ends with the suffix.
booleanaccept(File file, String name)
Checks to see if the filename ends with the suffix.

Field Detail

suffixes

private String[] suffixes
The filename suffixes to search for

Constructor Detail

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 null ClassCastException if the list does not contain Strings

Method Detail

accept

public boolean accept(File file)
Checks to see if the filename ends with the suffix.

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.

Parameters: file the File directory name the filename

Returns: true if the filename ends with one of our suffixes