blackboard.base
Class ListFilter

java.lang.Object
  blackboard.base.ListFilter

Direct Known Subclasses:

AvailabilityFilter, CourseMembershipRoleFilter, FilterCacheByLoader, GenericAttributeFilter, GenericFieldFilter

public abstract class ListFilter
extends java.lang.Object

Filters are used to get a sublist from a list using arbitrary, consumer defined, selection criteria.

Filters may be chained together via an internal linked list.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Nested Class Summary

static class

ListFilter.Comparison

Field Summary

static ListFilter

NOOP A convenient filter implementation that allows any object to pass.

Constructor Summary

ListFilter()

Method Summary

void	addFilter(ListFilter newFilter) Adds a filter to this linked list of filters.
protected abstract boolean	passesFilter(java.lang.Object listElement) Returns true if the given element passes this filter's tests for inclusion in the sublist.
boolean	passesFilters(java.lang.Object listElement) Returns true if the element passes all of the filters in this linked list.

Methods inherited from class java.lang.Object

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

Field Detail

NOOP

public static final ListFilter NOOP

A convenient filter implementation that allows any object to pass.

Since:

Bb 6.0.10

Constructor Detail

ListFilter

public ListFilter()

Method Detail

passesFilter

protected abstract boolean passesFilter(java.lang.Object listElement)

Returns true if the given element passes this filter's tests for inclusion in the sublist.

passesFilters

public boolean passesFilters(java.lang.Object listElement)

Returns true if the element passes all of the filters in this linked list.

addFilter

public void addFilter(ListFilter newFilter)

Adds a filter to this linked list of filters.