org.apache.commons.io.filefilter

Class PrefixFileFilter

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]);
 }
 

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[]prefixes
The filename prefixes to search for
Constructor Summary
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.
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.
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.
StringtoString()
Provide a String representaion of this file filter.

Field Detail

caseSensitivity

private final IOCase caseSensitivity
Whether the comparison is case sensitive.

prefixes

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

Throws: IllegalArgumentException if the prefix is null

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

Throws: IllegalArgumentException if the prefix array is 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

Throws: IllegalArgumentException if the prefix is null

Since: Commons IO 1.4

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

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

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

toString

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

Returns: a String representaion

Copyright (c) 2002-2011 Apache Software Foundation