com.communote.common.matcher

Class Matcher<T>

java.lang.Object

com.communote.common.matcher.Matcher<T>

Type Parameters:

T - Type of the entity to match.

Direct Known Subclasses:

AndMatcher, DateRangeMatcher, FavoriteMatcher, FollowingMatcher, FullTextSearchFiltersMatcher, NoteIdMatcher, OrMatcher, PropertyFilterMatcher, TagIdsMatcher, TopicIdsMatcher, UserAliasesMatcher, UserIdsMatcher, UsersToBeNotifiedMatcher

public abstract class Matcher<T>
extends Object

Abstract common class for entity matchers with helper methods.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
Matcher()

Method Summary

Modifier and Type	Method and Description
Collection<T>	filter(Collection<T> entities) Method to filter a given collection for matching elements.
void	markMatching(Collection<T> entities) Marks all matched entities as matched.
abstract boolean	matches(T entity) Method to check an entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

Matcher

public Matcher()

Method Detail

filter

public Collection<T> filter(Collection<T> entities)

Method to filter a given collection for matching elements. Only the matching elements will be returned.

Parameters:

entities - The entities to filter.

Returns:

A collection of entities, which matches this matcher.

markMatching

public void markMatching(Collection<T> entities)

Marks all matched entities as matched.

Note: The entities must implement the Matchable interface, else this method will immediately return.

Parameters:

entities - Entities to mark.

matches

public abstract boolean matches(T entity)

Method to check an entity.

Parameters:

entity - The entity to match.

Returns:

True, if the entity matches, else false.