Top Description Fields Constructors Methods
org.apache.commons.io.filefilter

public Class SuffixFileFilter

extends AbstractFileFilter
Class Inheritance
Imports
java.io.File, java.util.List
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]);
}
Authors
Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald
Since
Commons IO 1.0
Version
$Revision: 471628 $ $Date: 2006-11-06 05:06:45 +0100 (Mo, 06 Nov 2006) $

Field Summary

Modifier and TypeField and Description
private String[]
suffixes

The filename suffixes to search for

Constructor Summary

AccessConstructor and Description
public
SuffixFileFilter(String
the suffix to allow, must not be null
suffix)

Constructs a new Suffix file filter for a single extension.

public
SuffixFileFilter(String[]
the suffixes to allow, must not be null
suffixes)

Constructs a new Suffix file filter for an array of suffixs.

public
SuffixFileFilter(List<E>
the suffixes to allow, must not be null
suffixes)

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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the filename ends with one of our suffixes
accept(File
the File to check
file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename ends with the suffix.
public boolean

Returns:

true if the filename ends with one of our suffixes
accept(File
the File directory
file, String
the filename
name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename ends with the suffix.

Field Detail

suffixesback to summary
private String[] suffixes

The filename suffixes to search for

Constructor Detail

SuffixFileFilterback to summary
public SuffixFileFilter(String suffix)

Constructs a new Suffix file filter for a single extension.

Parameters
suffix:String

the suffix to allow, must not be null

Exceptions
IllegalArgumentException:
if the suffix is null
SuffixFileFilterback to summary
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:String[]

the suffixes to allow, must not be null

Exceptions
IllegalArgumentException:
if the suffix array is null
SuffixFileFilterback to summary
public SuffixFileFilter(List<E> suffixes)

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

Parameters
suffixes:List<E>

the suffixes to allow, must not be null

Exceptions
IllegalArgumentException:
if the suffix list is null
ClassCastException:
if the list does not contain Strings

Method Detail

acceptback to summary
public boolean accept(File file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename ends with the suffix.

Parameters
file:File

the File to check

Returns:boolean

true if the filename ends with one of our suffixes

acceptback to summary
public boolean accept(File file, String name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename ends with the suffix.

Parameters
file:File

the File directory

name:String

the filename

Returns:boolean

true if the filename ends with one of our suffixes