org.clapper.util.classutil
Class OrClassFilter

java.lang.Object
  org.clapper.util.classutil.OrClassFilter

All Implemented Interfaces:

ClassFilter

public final class OrClassFilter
extends java.lang.Object
implements ClassFilter

An OrClassFilter contains logically ORs other ClassFilter objects. When its accept() method is called, the OrClassFilter object passes the class name through the contained filters. The class name is accepted if it is accepted by any one of the contained filters. This class conceptually provides a logical "OR" operator for class name filters.

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

Version:

$Revision: 6735 $

Author:

Copyright © 2006 Brian M. Clapper

See Also:

ClassFilter, OrClassFilter, NotClassFilter, ClassFinder

Constructor Summary

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

OrClassFilter(ClassFilter... filters)
Construct a new OrClassFilter with two contained filters.

Method Summary

boolean	accept(ClassInfo classInfo, ClassFinder classFinder) Determine whether a class name is to be accepted or not, based on the contained filters.
OrClassFilter	addFilter(ClassFilter filter) Add a filter to the set of contained filters.
java.util.Collection<ClassFilter>	getFilters() Get the contained filters, as an unmodifiable collection.
int	getTotalFilters() Get the total number of contained filter objects (not counting any filter objects they, in turn, contain).
void	removeFilter(ClassFilter 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

OrClassFilter

public OrClassFilter()

Construct a new OrClassFilter with no contained filters.

OrClassFilter

public OrClassFilter(ClassFilter... filters)

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

Parameters:

filters - filters to add

Method Detail

addFilter

public OrClassFilter addFilter(ClassFilter filter)

Add a filter to the set of contained filters.

Parameters:

filter - the ClassFilter to add.

Returns:

this object, to permit chained calls.

See Also:

removeFilter(org.clapper.util.classutil.ClassFilter)

removeFilter

public void removeFilter(ClassFilter filter)

Remove a filter from the set of contained filters.

Parameters:

filter - the ClassFilter to remove.

See Also:

addFilter(org.clapper.util.classutil.ClassFilter)

getFilters

public java.util.Collection<ClassFilter> getFilters()

Get the contained filters, as an unmodifiable collection.

Returns:

the unmodifable Collection

getTotalFilters

public int getTotalFilters()

Get the total number of contained filter objects (not counting any filter objects they, in turn, contain).

Returns:

the total

accept

public boolean accept(ClassInfo classInfo,
                      ClassFinder classFinder)

Determine whether a class name is to be accepted or not, based on the contained filters. The class name name 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 true (implementing a "short-circuited OR" operation.)

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

Specified by:

accept in interface ClassFilter

Parameters:

classInfo - the ClassInfo object to test

classFinder - the invoking ClassFinder object

Returns:

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