org.apache.commons.io.filefilter

Class PrefixFileFilter

java.lang.Object

org.apache.commons.io.filefilter.AbstractFileFilter

org.apache.commons.io.filefilter.PrefixFileFilter

All Implemented Interfaces:

java.io.FileFilter, java.io.FilenameFilter, IOFileFilter

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

Fields

Modifier and Type	Field and Description
private java.lang.String[]	prefixes The filename prefixes to search for

Constructor Summary

Constructors

Constructor and Description
PrefixFileFilter(java.util.List prefixes) Constructs a new Prefix file filter for a list of prefixes.
PrefixFileFilter(java.lang.String prefix) Constructs a new Prefix file filter for a single prefix.
PrefixFileFilter(java.lang.String[] prefixes) Constructs a new Prefix file filter for any of an array of prefixes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Checks to see if the filename starts with the prefix.
boolean	accept(java.io.File file, java.lang.String name) Checks to see if the filename starts with the prefix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

prefixes

private java.lang.String[] prefixes

The filename prefixes to search for

Constructor Detail

PrefixFileFilter

public PrefixFileFilter(java.lang.String prefix)

Constructs a new Prefix file filter for a single prefix.

Parameters:

prefix - the prefix to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the prefix is null

PrefixFileFilter

public PrefixFileFilter(java.lang.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:

java.lang.IllegalArgumentException - if the prefix array is null

PrefixFileFilter

public PrefixFileFilter(java.util.List prefixes)

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

Parameters:

prefixes - the prefixes to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the prefix list is null

java.lang.ClassCastException - if the list does not contain Strings

Method Detail

accept

public boolean accept(java.io.File file)

Checks to see if the filename starts with the prefix.

Specified by:

accept in interface java.io.FileFilter

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File to check

Returns:

true if the filename starts with one of our prefixes

accept

public boolean accept(java.io.File file,
             java.lang.String name)

Checks to see if the filename starts with the prefix.

Specified by:

accept in interface java.io.FilenameFilter

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File directory

name - the filename

Returns:

true if the filename starts with one of our prefixes