Top Description Fields Constructors Methods
org.apache.commons.io.filefilter

public Class PrefixFileFilter

extends AbstractFileFilter
Class Inheritance
Imports
java.io.File, java.util.List
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]);
}
Authors
Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald
Since
Commons IO 1.0
Version
$Revision: 471628 $ $Date: 2006-11-06 05:06:45 +0100 (Mo, 06 Nov 2006) $

Field Summary

Modifier and TypeField and Description
private String[]
prefixes

The filename prefixes to search for

Constructor Summary

AccessConstructor and Description
public
PrefixFileFilter(String
the prefix to allow, must not be null
prefix)

Constructs a new Prefix file filter for a single prefix.

public
PrefixFileFilter(String[]
the prefixes to allow, must not be null
prefixes)

Constructs a new Prefix file filter for any of an array of prefixes.

public
PrefixFileFilter(List<E>
the prefixes to allow, must not be null
prefixes)

Constructs a new Prefix file filter for a list of prefixes.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the filename starts with one of our prefixes
accept(File
the File to check
file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename starts with the prefix.
public boolean

Returns:

true if the filename starts with one of our prefixes
accept(File
the File directory
file, String
the filename
name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename starts with the prefix.

Field Detail

prefixesback to summary
private String[] prefixes

The filename prefixes to search for

Constructor Detail

PrefixFileFilterback to summary
public PrefixFileFilter(String prefix)

Constructs a new Prefix file filter for a single prefix.

Parameters
prefix:String

the prefix to allow, must not be null

Exceptions
IllegalArgumentException:
if the prefix is null
PrefixFileFilterback to summary
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:String[]

the prefixes to allow, must not be null

Exceptions
IllegalArgumentException:
if the prefix array is null
PrefixFileFilterback to summary
public PrefixFileFilter(List<E> prefixes)

Constructs a new Prefix file filter for a list of prefixes.

Parameters
prefixes:List<E>

the prefixes to allow, must not be null

Exceptions
IllegalArgumentException:
if the prefix list is null
ClassCastException:
if the list does not contain Strings

Method Detail

acceptback to summary
public boolean accept(File file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename starts with the prefix.

Parameters
file:File

the File to check

Returns:boolean

true if the filename starts with one of our prefixes

acceptback to summary
public boolean accept(File file, String name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename starts with the prefix.

Parameters
file:File

the File directory

name:String

the filename

Returns:boolean

true if the filename starts with one of our prefixes