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:

Commons IO 1.0

Version:

$Id: FileFilterUtils.java 369075 2006-01-14 18:23:42Z scolebourne $

Constructor Summary

FileFilterUtils()
FileFilterUtils is not normally instantiated.

Method Summary

static IOFileFilter	ageFileFilter(Date cutoffDate) Returns a filter that returns true if the file was last modified after the specified cutoff date.
static IOFileFilter	ageFileFilter(Date cutoffDate, boolean acceptOlder) Returns a filter that filters files based on a cutoff date.
static IOFileFilter	ageFileFilter(File cutoffReference) Returns a filter that returns true if the file was last modified after the specified reference file.
static IOFileFilter	ageFileFilter(File cutoffReference, boolean acceptOlder) Returns a filter that filters files based on a cutoff reference file.
static IOFileFilter	ageFileFilter(long cutoff) Returns a filter that returns true if the file was last modified after the specified cutoff time.
static IOFileFilter	ageFileFilter(long cutoff, boolean acceptOlder) Returns a filter that filters files based on a cutoff time.
static IOFileFilter	andFileFilter(IOFileFilter filter1, IOFileFilter filter2) Returns a filter that ANDs the two specified filters.
static IOFileFilter	asFileFilter(FileFilter filter) Returns an IOFileFilter that wraps the FileFilter instance.
static IOFileFilter	asFileFilter(FilenameFilter filter) Returns an IOFileFilter that wraps the FilenameFilter instance.
static IOFileFilter	directoryFileFilter() Returns a filter that checks if the file is a directory.
static IOFileFilter	falseFileFilter() Returns a filter that always returns false.
static IOFileFilter	makeCVSAware(IOFileFilter filter) Returns an IOFileFilter that ignores CVS directories.
static IOFileFilter	makeSVNAware(IOFileFilter filter) Returns an IOFileFilter that ignores SVN directories.
static IOFileFilter	nameFileFilter(String name) Returns a filter that returns true if the filename matches the specified text.
static IOFileFilter	notFileFilter(IOFileFilter filter) Returns a filter that NOTs the specified filter.
static IOFileFilter	orFileFilter(IOFileFilter filter1, IOFileFilter filter2) Returns a filter that ORs the two specified filters.
static IOFileFilter	prefixFileFilter(String prefix) Returns a filter that returns true if the filename starts with the specified text.
static IOFileFilter	sizeFileFilter(long threshold) Returns a filter that returns true if the file is bigger than a certain size.
static IOFileFilter	sizeFileFilter(long threshold, boolean acceptLarger) Returns a filter that filters based on file size.
static IOFileFilter	suffixFileFilter(String suffix) Returns a filter that returns true if the filename ends with the specified text.
static IOFileFilter	trueFileFilter() Returns a filter that always returns true.

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

prefixFileFilter

public static IOFileFilter prefixFileFilter(String prefix)

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

Parameters:

prefix - the filename prefix

Returns:

a prefix checking filter

suffixFileFilter

public static IOFileFilter suffixFileFilter(String suffix)

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

Parameters:

suffix - the filename suffix

Returns:

a suffix checking filter

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

directoryFileFilter

public static IOFileFilter directoryFileFilter()

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

Returns:

directory file filter

andFileFilter

public static IOFileFilter andFileFilter(IOFileFilter filter1,
                                         IOFileFilter filter2)

Returns a filter that ANDs the two specified filters.

Parameters:

filter1 - the first filter

filter2 - the second filter

Returns:

a filter that ANDs the two specified filters

orFileFilter

public static IOFileFilter orFileFilter(IOFileFilter filter1,
                                        IOFileFilter filter2)

Returns a filter that ORs the two specified filters.

Parameters:

filter1 - the first filter

filter2 - the second filter

Returns:

a filter that ORs the two specified filters

notFileFilter

public static IOFileFilter notFileFilter(IOFileFilter filter)

Returns a filter that NOTs the specified filter.

Parameters:

filter - the filter to invert

Returns:

a filter that NOTs the specified filter

trueFileFilter

public static IOFileFilter trueFileFilter()

Returns a filter that always returns true.

Returns:

a true filter

falseFileFilter

public static IOFileFilter falseFileFilter()

Returns a filter that always returns false.

Returns:

a false filter

asFileFilter

public static IOFileFilter asFileFilter(FileFilter filter)

Returns an IOFileFilter that wraps the FileFilter instance.

Parameters:

filter - the filter to be wrapped

Returns:

a new filter that implements IOFileFilter

asFileFilter

public static IOFileFilter asFileFilter(FilenameFilter filter)

Returns an IOFileFilter that wraps the FilenameFilter instance.

Parameters:

filter - the filter to be wrapped

Returns:

a new filter that implements IOFileFilter

makeCVSAware

public static IOFileFilter makeCVSAware(IOFileFilter filter)

Returns an IOFileFilter that ignores CVS directories. You may optionally pass in an existing IOFileFilter in which case it is extended to exclude CVS directories.

Parameters:

filter - IOFileFilter to wrap, null if a new IOFileFilter should be created

Returns:

the requested (combined) filter

Since:

1.1 (method existed but had bug in 1.0)

makeSVNAware

public static IOFileFilter makeSVNAware(IOFileFilter filter)

Returns an IOFileFilter that ignores SVN directories. You may optionally pass in an existing IOFileFilter in which case it is extended to exclude SVN directories.

Parameters:

filter - IOFileFilter to wrap, null if a new IOFileFilter should be created

Returns:

the requested (combined) filter

Since:

1.1

ageFileFilter

public static IOFileFilter ageFileFilter(long cutoff)

Returns a filter that returns true if the file was last modified after the specified cutoff time.

Parameters:

cutoff - the time threshold

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

ageFileFilter

public static IOFileFilter ageFileFilter(long cutoff,
                                         boolean acceptOlder)

Returns a filter that filters files based on a cutoff time.

Parameters:

cutoff - the time threshold

acceptOlder - if true, older files get accepted, if false, newer

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

ageFileFilter

public static IOFileFilter ageFileFilter(Date cutoffDate)

Returns a filter that returns true if the file was last modified after the specified cutoff date.

Parameters:

cutoffDate - the time threshold

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

ageFileFilter

public static IOFileFilter ageFileFilter(Date cutoffDate,
                                         boolean acceptOlder)

Returns a filter that filters files based on a cutoff date.

Parameters:

cutoffDate - the time threshold

acceptOlder - if true, older files get accepted, if false, newer

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

ageFileFilter

public static IOFileFilter ageFileFilter(File cutoffReference)

Returns a filter that returns true if the file was last modified after the specified reference file.

Parameters:

cutoffReference - the file whose last modification time is usesd as the threshold age of the files

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

ageFileFilter

public static IOFileFilter ageFileFilter(File cutoffReference,
                                         boolean acceptOlder)

Returns a filter that filters files based on a cutoff reference file.

Parameters:

cutoffReference - the file whose last modification time is usesd as the threshold age of the files

acceptOlder - if true, older files get accepted, if false, newer

Returns:

an appropriately configured age file filter

Since:

Commons IO 1.2

sizeFileFilter

public static IOFileFilter sizeFileFilter(long threshold)

Returns a filter that returns true if the file is bigger than a certain size.

Parameters:

threshold - the file size threshold

Returns:

an appropriately configured SizeFileFilter

Since:

Commons IO 1.2

sizeFileFilter

public static IOFileFilter sizeFileFilter(long threshold,
                                          boolean acceptLarger)

Returns a filter that filters based on file size.

Parameters:

threshold - the file size threshold

acceptLarger - if true, larger files get accepted, if false, smaller

Returns:

an appropriately configured SizeFileFilter

Since:

Commons IO 1.2