org.apache.commons.io.filefilter
Class NameFileFilter

java.lang.Object
  org.apache.commons.io.filefilter.AbstractFileFilter
      org.apache.commons.io.filefilter.NameFileFilter

All Implemented Interfaces:

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

public class NameFileFilter

extends AbstractFileFilter

Filters filenames for a certain name.

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

 File dir = new File(".");
 String[] files = dir.list( new NameFileFilter("Test") );
 for ( int i = 0; i < files.length; i++ ) {
     System.out.println(files[i]);
 }
 

Since:

Commons IO 1.0

Version:

$Revision: 155419 $ $Date: 2005-02-26 13:02:41 +0000 (Sat, 26 Feb 2005) $

Author:

Henri Yandell, Stephen Colebourne, Federico Barbieri, Serge Knystautas, Peter Donald

Field Summary

private java.lang.String[]

names The filenames to search for

Constructor Summary

NameFileFilter(java.util.List names)
Constructs a new name file filter for a list of names.

NameFileFilter(java.lang.String name)
Constructs a new name file filter for a single name.

NameFileFilter(java.lang.String[] names)
Constructs a new name file filter for any of an array of names.

Method Summary

boolean	accept(java.io.File file) Checks to see if the filename matches.
boolean	accept(java.io.File file, java.lang.String name) Checks to see if the filename matches.

Methods inherited from class java.lang.Object

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

Field Detail

names

private java.lang.String[] names

The filenames to search for

Constructor Detail

NameFileFilter

public NameFileFilter(java.lang.String name)

Constructs a new name file filter for a single name.

Parameters:

name - the name to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the prefix is null

NameFileFilter

public NameFileFilter(java.lang.String[] names)

Constructs a new name file filter for any of an array of names.

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

Parameters:

names - the names to allow, must not be null

Throws:

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

NameFileFilter

public NameFileFilter(java.util.List names)

Constructs a new name file filter for a list of names.

Parameters:

names - the names to allow, must not be null

Throws:

java.lang.IllegalArgumentException - if the name 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 matches.

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File to check

Returns:

true if the filename matches

accept

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

Checks to see if the filename matches.

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File directory

name - the filename

Returns:

true if the filename matches