org.apache.commons.io.filefilter

Class SuffixFileFilter

public class SuffixFileFilter extends AbstractFileFilter implements Serializable

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: 606381 $ $Date: 2007-12-22 02:03:16 +0000 (Sat, 22 Dec 2007) $

Author: Stephen Colebourne Federico Barbieri Serge Knystautas Peter Donald

Field Summary
IOCasecaseSensitivity
Whether the comparison is case sensitive.
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 suffix, IOCase caseSensitivity)
Constructs a new Suffix file filter for a single extension specifying case-sensitivity.
SuffixFileFilter(String[] suffixes)
Constructs a new Suffix file filter for an array of suffixs.
SuffixFileFilter(String[] suffixes, IOCase caseSensitivity)
Constructs a new Suffix file filter for an array of suffixs specifying case-sensitivity.
SuffixFileFilter(List suffixes)
Constructs a new Suffix file filter for a list of suffixes.
SuffixFileFilter(List suffixes, IOCase caseSensitivity)
Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.
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.
StringtoString()
Provide a String representaion of this file filter.

Field Detail

caseSensitivity

private final IOCase caseSensitivity
Whether the comparison is case sensitive.

suffixes

private final 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 suffix, IOCase caseSensitivity)
Constructs a new Suffix file filter for a single extension specifying case-sensitivity.

Parameters: suffix the suffix to allow, must not be null caseSensitivity how to handle case sensitivity, null means case-sensitive

Throws: IllegalArgumentException if the suffix is null

Since: Commons IO 1.4

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(String[] suffixes, IOCase caseSensitivity)
Constructs a new Suffix file filter for an array of suffixs specifying case-sensitivity.

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 caseSensitivity how to handle case sensitivity, null means case-sensitive

Throws: IllegalArgumentException if the suffix array is null

Since: Commons IO 1.4

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

SuffixFileFilter

public SuffixFileFilter(List suffixes, IOCase caseSensitivity)
Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.

Parameters: suffixes the suffixes to allow, must not be null caseSensitivity how to handle case sensitivity, null means case-sensitive

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

Since: Commons IO 1.4

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

toString

public String toString()
Provide a String representaion of this file filter.

Returns: a String representaion

Copyright (c) 2002-2011 Apache Software Foundation