org.apache.commons.io.filefilter

Class SuffixFileFilter

Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, IOFileFilter

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]);
 }
 
Version:
$Revision: 606381 $ $Date: 2007-12-22 02:03:16 +0000 (Sat, 22 Dec 2007) $
Authors:
Stephen Colebourne
Federico Barbieri
Serge Knystautas
Peter Donald
Since:
Commons IO 1.0

Field Summary

private IOCase
caseSensitivity
Whether the comparison is case sensitive.
private String[]
suffixes
The filename suffixes to search for

Constructor Summary

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.
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.

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.
String
toString()
Provide a String representaion of this file filter.

Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter

accept, accept, toString

Field Details

caseSensitivity

private final IOCase caseSensitivity
Whether the comparison is case sensitive.

suffixes

private final String[] suffixes
The filename suffixes to search for

Constructor Details

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

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
Since:
Commons IO 1.4

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

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
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

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
Since:
Commons IO 1.4

Method Details

accept

public boolean accept(File file)
Checks to see if the filename ends with the suffix.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface 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.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface AbstractFileFilter
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.
Overrides:
toString in interface AbstractFileFilter
Returns:
a String representaion

Copyright (c) 2002-2009 Apache Software Foundation