Package org.apache.commons.io.filefilter

Class FileFilterUtils

java.lang.Object

org.apache.commons.io.filefilter.FileFilterUtils

public class FileFilterUtils
extends Object

Useful utilities for working with file filters. It provides access to all file filter implementations in this package so you don't have to import every class you use.

Since:

1.0

Version:

$Id: FileFilterUtils.java 1304052 2012-03-22 20:55:29Z ggregory $

Constructor Summary

Constructors

Constructor	Description
FileFilterUtils()	FileFilterUtils is not normally instantiated.

Method Summary

Modifier and Type	Method	Description
static IOFileFilter	directoryFileFilter()	Returns a filter that checks if the file is a directory.
static IOFileFilter	fileFileFilter()	Returns a filter that checks if the file is a file (and not a directory).
static File[]	filter(IOFileFilter filter, File... files)	Applies an IOFileFilter to the provided File objects.
static File[]	filter(IOFileFilter filter, Iterable<File> files)	Applies an IOFileFilter to the provided File objects.
static List<File>	filterList(IOFileFilter filter, File... files)	Applies an IOFileFilter to the provided File objects.
static List<File>	filterList(IOFileFilter filter, Iterable<File> files)	Applies an IOFileFilter to the provided File objects.
static Set<File>	filterSet(IOFileFilter filter, File... files)	Applies an IOFileFilter to the provided File objects.
static Set<File>	filterSet(IOFileFilter filter, Iterable<File> files)	Applies an IOFileFilter to the provided File objects.
static IOFileFilter	nameFileFilter(String name)	Returns a filter that returns true if the filename matches the specified text.
static IOFileFilter	nameFileFilter(String name, IOCase caseSensitivity)	Returns a filter that returns true if the filename matches the specified text.
static List<IOFileFilter>	toList(IOFileFilter... filters)	Create a List of file filters.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFilterUtils

public FileFilterUtils()

FileFilterUtils is not normally instantiated.

Method Detail

filter

public static File[] filter(IOFileFilter filter,
                            File... files)

Applies an IOFileFilter to the provided File objects. The resulting array is a subset of the original file list that matches the provided filter.

The Set returned by this method is not guaranteed to be thread safe.

 Set<File> allFiles = ...
 Set<File> javaFiles = FileFilterUtils.filterSet(allFiles,
     FileFilterUtils.suffixFileFilter(".java"));
 

Parameters:

filter - the filter to apply to the set of files.

files - the array of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

filter

public static File[] filter(IOFileFilter filter,
                            Iterable<File> files)

Applies an IOFileFilter to the provided File objects. The resulting array is a subset of the original file list that matches the provided filter.

The Set returned by this method is not guaranteed to be thread safe.

 Set<File> allFiles = ...
 Set<File> javaFiles = FileFilterUtils.filterSet(allFiles,
     FileFilterUtils.suffixFileFilter(".java"));
 

Parameters:

filter - the filter to apply to the set of files.

files - the array of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

filterList

public static List<File> filterList(IOFileFilter filter,
                                    Iterable<File> files)

Applies an IOFileFilter to the provided File objects. The resulting list is a subset of the original files that matches the provided filter.

The List returned by this method is not guaranteed to be thread safe.

 List<File> filesAndDirectories = ...
 List<File> directories = FileFilterUtils.filterList(filesAndDirectories,
     FileFilterUtils.directoryFileFilter());
 

Parameters:

filter - the filter to apply to each files in the list.

files - the collection of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

filterList

public static List<File> filterList(IOFileFilter filter,
                                    File... files)

Applies an IOFileFilter to the provided File objects. The resulting list is a subset of the original files that matches the provided filter.

The List returned by this method is not guaranteed to be thread safe.

 List<File> filesAndDirectories = ...
 List<File> directories = FileFilterUtils.filterList(filesAndDirectories,
     FileFilterUtils.directoryFileFilter());
 

Parameters:

filter - the filter to apply to each files in the list.

files - the collection of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

filterSet

public static Set<File> filterSet(IOFileFilter filter,
                                  File... files)

Applies an IOFileFilter to the provided File objects. The resulting set is a subset of the original file list that matches the provided filter.

The Set returned by this method is not guaranteed to be thread safe.

 Set<File> allFiles = ...
 Set<File> javaFiles = FileFilterUtils.filterSet(allFiles,
     FileFilterUtils.suffixFileFilter(".java"));
 

Parameters:

filter - the filter to apply to the set of files.

files - the collection of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

filterSet

public static Set<File> filterSet(IOFileFilter filter,
                                  Iterable<File> files)

Applies an IOFileFilter to the provided File objects. The resulting set is a subset of the original file list that matches the provided filter.

The Set returned by this method is not guaranteed to be thread safe.

 Set<File> allFiles = ...
 Set<File> javaFiles = FileFilterUtils.filterSet(allFiles,
     FileFilterUtils.suffixFileFilter(".java"));
 

Parameters:

filter - the filter to apply to the set of files.

files - the collection of files to apply the filter to.

Returns:

a subset of files that is accepted by the file filter.

Throws:

IllegalArgumentException - if the filter is null or files contains a null value.

Since:

2.0

nameFileFilter

public static IOFileFilter nameFileFilter(String name)

Returns a filter that returns true if the filename matches the specified text.

Parameters:

name - the filename

Returns:

a name checking filter

See Also:

NameFileFilter

nameFileFilter

public static IOFileFilter nameFileFilter(String name,
                                          IOCase caseSensitivity)

Returns a filter that returns true if the filename matches the specified text.

Parameters:

name - the filename

caseSensitivity - how to handle case sensitivity, null means case-sensitive

Returns:

a name checking filter

Since:

2.0

See Also:

NameFileFilter

directoryFileFilter

public static IOFileFilter directoryFileFilter()

Returns a filter that checks if the file is a directory.

Returns:

file filter that accepts only directories and not files

See Also:

DirectoryFileFilter.DIRECTORY

fileFileFilter

public static IOFileFilter fileFileFilter()

Returns a filter that checks if the file is a file (and not a directory).

Returns:

file filter that accepts only files and not directories

See Also:

FileFileFilter.FILE

toList

public static List<IOFileFilter> toList(IOFileFilter... filters)

Create a List of file filters.

Parameters:

filters - The file filters

Returns:

The list of file filters

Throws:

IllegalArgumentException - if the filters are null or contain a null value.

Since:

2.0