org.clapper.util.io
Class AndFilenameFilter

java.lang.Object
  org.clapper.util.io.AndFilenameFilter

All Implemented Interfaces:

java.io.FilenameFilter

public final class AndFilenameFilter
extends java.lang.Object
implements java.io.FilenameFilter

An AndFilenameFilter logically ANDs other java.io.FilenameFilter objects. When its accept() method is called, the AndFilenameFilter object passes the file through the contained filters. The file is only accepted if it is accepted by all contained filters. This class conceptually provides a logical "AND" operator for file filters.

The contained filters are applied in the order they were added to the AndFilenameFilter object. This class's accept() method stops looping over the contained filters as soon as it encounters one whose accept() method returns false (implementing a "short-circuited AND" operation.)

Version:

$Revision: 5812 $

Author:

Copyright © 2004-2007 Brian M. Clapper

See Also:

FilenameFilter, OrFilenameFilter, NotFilenameFilter, RegexFilenameFilter, AndFileFilter

Constructor Summary

AndFilenameFilter()
Construct a new AndFilenameFilter with no contained filters.

AndFilenameFilter(java.io.FilenameFilter... filters)
Construct a new AndFilenameFilter with a set of contained filters.

Method Summary

boolean	accept(java.io.File dir, java.lang.String name) Determine whether a file is to be accepted or not, based on the contained filters.
AndFilenameFilter	addFilter(java.io.FilenameFilter filter) Add a filter to the set of contained filters.
void	removeFilter(java.io.FilenameFilter filter) Remove a filter from the set of contained filters.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndFilenameFilter

public AndFilenameFilter()

Construct a new AndFilenameFilter with no contained filters.

AndFilenameFilter

public AndFilenameFilter(java.io.FilenameFilter... filters)

Construct a new AndFilenameFilter with a set of contained filters. Additional filters may be added later, via calls to the addFilter() method.

Parameters:

filters - filters to use

Method Detail

addFilter

public AndFilenameFilter addFilter(java.io.FilenameFilter filter)

Add a filter to the set of contained filters.

Parameters:

filter - the FilenameFilter to add.

Returns:

this object, to permit chained calls.

See Also:

removeFilter(java.io.FilenameFilter)

removeFilter

public void removeFilter(java.io.FilenameFilter filter)

Remove a filter from the set of contained filters.

Parameters:

filter - the FilenameFilter to remove.

See Also:

addFilter(java.io.FilenameFilter)

accept

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

Determine whether a file is to be accepted or not, based on the contained filters. The file is accepted if any one of the contained filters accepts it. This method stops looping over the contained filters as soon as it encounters one whose accept() method returns false (implementing a "short-circuited AND" operation.)

If the set of contained filters is empty, then this method returns true.

Specified by:

accept in interface java.io.FilenameFilter

Parameters:

dir - The directory containing the file.

name - the file name

Returns:

true if the file matches, false if it doesn't