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:

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

Author:

Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	suffixes The filename suffixes to search for

Constructor Summary

Constructors

Constructor and Description
SuffixFileFilter(java.util.List suffixes) Constructs a new Suffix file filter for a list of suffixes.
SuffixFileFilter(java.lang.String suffix) Constructs a new Suffix file filter for a single extension.
SuffixFileFilter(java.lang.String[] suffixes) Constructs a new Suffix file filter for an array of suffixs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Checks to see if the filename ends with the suffix.
boolean	accept(java.io.File file, java.lang.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, toString, wait, wait, wait

Field Detail

suffixes

private java.lang.String[] suffixes

The filename suffixes to search for

Constructor Detail

SuffixFileFilter

public SuffixFileFilter(java.lang.String suffix)

Constructs a new Suffix file filter for a single extension.

Parameters:

suffix - the suffix to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the suffix is null

SuffixFileFilter

public SuffixFileFilter(java.lang.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:

java.lang.IllegalArgumentException - if the suffix array is null

SuffixFileFilter

public SuffixFileFilter(java.util.List suffixes)

Constructs a new Suffix file filter for a list of suffixes.

Parameters:

suffixes - the suffixes to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the suffix list is null

java.lang.ClassCastException - if the list does not contain Strings

Method Detail

accept

public boolean accept(java.io.File file)

Checks to see if the filename ends with the suffix.

Specified by:

accept in interface java.io.FileFilter

Specified by:

accept in interface IOFileFilter

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(java.io.File file,
             java.lang.String name)

Checks to see if the filename ends with the suffix.

Specified by:

accept in interface java.io.FilenameFilter

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File directory

name - the filename

Returns:

true if the filename ends with one of our suffixes