org.apache.commons.io.filefilter

Class PrefixFileFilter

public class PrefixFileFilter extends AbstractFileFilter

Filters filenames for a certain prefix.

For example, to print all files and directories in the current directory whose name starts with Test:

 File dir = new File(".");
 String[] files = dir.list( new PrefixFileFilter("Test") );
 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[]prefixes
The filename prefixes to search for
Constructor Summary
PrefixFileFilter(String prefix)
Constructs a new Prefix file filter for a single prefix.
PrefixFileFilter(String[] prefixes)
Constructs a new Prefix file filter for any of an array of prefixes.
PrefixFileFilter(List prefixes)
Constructs a new Prefix file filter for a list of prefixes.
Method Summary
booleanaccept(File file)
Checks to see if the filename starts with the prefix.
booleanaccept(File file, String name)
Checks to see if the filename starts with the prefix.

Field Detail

prefixes

private String[] prefixes
The filename prefixes to search for

Constructor Detail

PrefixFileFilter

public PrefixFileFilter(String prefix)
Constructs a new Prefix file filter for a single prefix.

Parameters: prefix the prefix to allow, must not be null

Throws: IllegalArgumentException if the prefix is null

PrefixFileFilter

public PrefixFileFilter(String[] prefixes)
Constructs a new Prefix file filter for any of an array of prefixes.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters: prefixes the prefixes to allow, must not be null

Throws: IllegalArgumentException if the prefix array is null

PrefixFileFilter

public PrefixFileFilter(List prefixes)
Constructs a new Prefix file filter for a list of prefixes.

Parameters: prefixes the prefixes to allow, must not be null

Throws: IllegalArgumentException if the prefix 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 starts with the prefix.

Parameters: file the File to check

Returns: true if the filename starts with one of our prefixes

accept

public boolean accept(File file, String name)
Checks to see if the filename starts with the prefix.

Parameters: file the File directory name the filename

Returns: true if the filename starts with one of our prefixes