org.pfsw.util

Class ObjectCollectionFilter<T>

java.lang.Object

org.pfsw.util.ObjectCollectionFilter<T>

All Implemented Interfaces:

IObjectFilter<T>, ObjectFilter<T>

public class ObjectCollectionFilter<T>
extends java.lang.Object
implements ObjectFilter<T>

This filter returns tru if a given object is contained in the underlying collection of objects. It is possible to specify whether to use equality or identity to determine if an object is in the collection. The default is equality check.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_USE_IDENTITY

Constructor Summary

Constructors

Constructor and Description
ObjectCollectionFilter(java.util.Collection<T> objects) Initialize the new instance with some objects.
ObjectCollectionFilter(java.util.Collection<T> objects, boolean identity) Initialize the new instance with some objects.
ObjectCollectionFilter(T[] objects) Initialize the new instance with some objects.
ObjectCollectionFilter(T[] objects, boolean identity) Initialize the new instance with some objects.

Method Summary

Modifier and Type	Method and Description
protected boolean	getNegated()
protected java.util.Collection<T>	getObjectCollection()
protected boolean	getUseIdentity()
boolean	matches(T object) Returns true if the given object is in the collection
void	negate() This method reverses the logic of the filter.
protected java.util.Collection<T>	newCollection(int initialCapacity)
protected void	setNegated(boolean newValue)
protected void	setObjectCollection(java.util.Collection<T> newValue)
protected void	setUseIdentity(boolean newValue)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USE_IDENTITY

protected static final boolean DEFAULT_USE_IDENTITY

See Also:

Constant Field Values

Constructor Detail

ObjectCollectionFilter

public ObjectCollectionFilter(java.util.Collection<T> objects)

Initialize the new instance with some objects. The default comparison method is equality.

Parameters:

objects - The object to keep in the filter

ObjectCollectionFilter

public ObjectCollectionFilter(java.util.Collection<T> objects,
                              boolean identity)

Initialize the new instance with some objects.

Parameters:

objects - The object to keep in the filter

identity - If true an identity comparison is done rather than equality check

ObjectCollectionFilter

public ObjectCollectionFilter(T[] objects)

Initialize the new instance with some objects. The default comparison method is equality.

Parameters:

objects - The object to keep in the filter

ObjectCollectionFilter

public ObjectCollectionFilter(T[] objects,
                              boolean identity)

Initialize the new instance with some objects.

Parameters:

objects - The object to keep in the filter

identity - If true an identity comparison is done rather than equality check

Method Detail

matches

public boolean matches(T object)

Returns true if the given object is in the collection

Specified by:

matches in interface IObjectFilter<T>

Parameters:

object - Any object or null

negate

public void negate()

This method reverses the logic of the filter. That is, for all objects matches() returned true before, now matches() returns false and vice versa.

newCollection

protected java.util.Collection<T> newCollection(int initialCapacity)

getObjectCollection

protected java.util.Collection<T> getObjectCollection()

setObjectCollection

protected void setObjectCollection(java.util.Collection<T> newValue)

getUseIdentity

protected boolean getUseIdentity()

setUseIdentity

protected void setUseIdentity(boolean newValue)

getNegated

protected boolean getNegated()

setNegated

protected void setNegated(boolean newValue)