org.apache.commons.io.filefilter

Class PrefixFileFilter

Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, IOFileFilter

public class PrefixFileFilter
extends AbstractFileFilter
implements Serializable

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]);
 }
 
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[]
prefixes
The filename prefixes to search for

Constructor Summary

PrefixFileFilter(List prefixes)
Constructs a new Prefix file filter for a list of prefixes.
PrefixFileFilter(List prefixes, IOCase caseSensitivity)
Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity.
PrefixFileFilter(String prefix)
Constructs a new Prefix file filter for a single prefix.
PrefixFileFilter(String prefix, IOCase caseSensitivity)
Constructs a new Prefix file filter for a single prefix specifying case-sensitivity.
PrefixFileFilter(String[] prefixes)
Constructs a new Prefix file filter for any of an array of prefixes.
PrefixFileFilter(String[] prefixes, IOCase caseSensitivity)
Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.

Method Summary

boolean
accept(File file)
Checks to see if the filename starts with the prefix.
boolean
accept(File file, String name)
Checks to see if the filename starts with the prefix.
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.

prefixes

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

Constructor Details

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

PrefixFileFilter

public PrefixFileFilter(List prefixes,
                        IOCase caseSensitivity)
Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity.
Parameters:
prefixes - the prefixes to allow, must not be null
caseSensitivity - how to handle case sensitivity, null means case-sensitive
Since:
Commons IO 1.4

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

PrefixFileFilter

public PrefixFileFilter(String prefix,
                        IOCase caseSensitivity)
Constructs a new Prefix file filter for a single prefix specifying case-sensitivity.
Parameters:
prefix - the prefix to allow, must not be null
caseSensitivity - how to handle case sensitivity, null means case-sensitive
Since:
Commons IO 1.4

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

PrefixFileFilter

public PrefixFileFilter(String[] prefixes,
                        IOCase caseSensitivity)
Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.

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
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 starts with the prefix.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface AbstractFileFilter
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.
Specified by:
accept in interface IOFileFilter
Overrides:
accept in interface AbstractFileFilter
Parameters:
file - the File directory
name - the filename
Returns:
true if the filename starts with one of our prefixes

toString

public String toString()
Provide a String representaion of this file filter.
Overrides:
toString in interface AbstractFileFilter
Returns:
a String representaion

Copyright (c) 2002-2008 Apache Software Foundation