org.jjoost.util.filters
Class AcceptEqual<E>

java.lang.Object
  org.jjoost.util.filters.AcceptEqual<E>

All Implemented Interfaces:

java.io.Serializable, Filter<E>, FilterPartialOrder<E>, BothFilter<E>

public class AcceptEqual<E>
extends java.lang.Object
implements BothFilter<E>

A filter accepting only values equal to the one provided, using the provided definition of equality. The filter implements both Filter and FilterPartialOrder.

See Also:

Serialized Form

Constructor Summary

AcceptEqual(E than, Equality<? super E> equality)
Constructs a new filter accepting only values equal to the one provided, using the provided definition of equality.

Method Summary

boolean	accept(E test) Returns true if the Filter accepts the parameter and false otherwise
boolean	accept(E test, java.util.Comparator<? super E> cmp) Return true iff this filter and comparator combination accept the provided value
static <E> AcceptEqual<E>	get(E than) Constructs a new filter accepting only values equal to the one provided, using default object equality.
static <E> AcceptEqual<E>	get(E than, Equality<? super E> equality) Constructs a new filter accepting only values equal to the one provided, using the provided definition of equality.
boolean	mayAcceptBetween(E lb, boolean lbInclusive, E ub, boolean ubInclusive, java.util.Comparator<? super E> cmp) Returns true if there exists (in the total order defined by the comparator, not necessarily in any concrete data set this is being applied to) a value between lb and ub that this filter may accept.
boolean	mayRejectBetween(E lb, boolean lbInclusive, E ub, boolean ubInclusive, java.util.Comparator<? super E> cmp) Returns true if there exists (in the total order defined by the comparator, not necessarily in any concrete data set this is being applied to) a value between lb and ub that this filter may reject.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AcceptEqual

public AcceptEqual(E than,
                   Equality<? super E> equality)

Constructs a new filter accepting only values equal to the one provided, using the provided definition of equality. The filter implements both Filter and FilterPartialOrder.

Parameters:

than - value to accept

equality - the definition of equality

Method Detail

accept

public boolean accept(E test)

Description copied from interface: Filter

Returns true if the Filter accepts the parameter and false otherwise

Specified by:

accept in interface Filter<E>

Parameters:

test - value to test

Returns:

true if the filter accepts test; false otherwise

accept

public boolean accept(E test,
                      java.util.Comparator<? super E> cmp)

Description copied from interface: FilterPartialOrder

Return true iff this filter and comparator combination accept the provided value

Specified by:

accept in interface FilterPartialOrder<E>

Parameters:

test - the value to check

cmp - the partial order

Returns:

true, if accepts

mayAcceptBetween

public boolean mayAcceptBetween(E lb,
                                boolean lbInclusive,
                                E ub,
                                boolean ubInclusive,
                                java.util.Comparator<? super E> cmp)

Description copied from interface: FilterPartialOrder

Returns true if there exists (in the total order defined by the comparator, not necessarily in any concrete data set this is being applied to) a value between lb and ub that this filter may accept. This method may return true if there is no such value, at the cost of more expensive execution but valid behaviour, however it cannot return false if there is such a value without breaking functionality. null values should be seen as both +/- infinity, i.e. containsBetween(null, o) should return containsBefore(o) and containsBetween(o, null) should return containsAfter(o) containsBetween should take arguments IN ORDER, i.e. o1 <= o2; behaviour where o2 < o1 is undefined.

Specified by:

mayAcceptBetween in interface FilterPartialOrder<E>

Parameters:

lb - the lower bound of the range to check

lbInclusive - if the lower bound should be taken as inclusive

ub - the upper bound of the range to check

ubInclusive - if the upper bound should be taken as inclusive

cmp - the partial order

Returns:

true, if there may exists a value V such that lb <(/<=) V <(/<=) ub and accept(V, cmp) == true

mayRejectBetween

public boolean mayRejectBetween(E lb,
                                boolean lbInclusive,
                                E ub,
                                boolean ubInclusive,
                                java.util.Comparator<? super E> cmp)

Description copied from interface: FilterPartialOrder

Returns true if there exists (in the total order defined by the comparator, not necessarily in any concrete data set this is being applied to) a value between lb and ub that this filter may reject. This method may return true if there is no such value at the cost of more expensive execution but valid behaviour, however it cannot return false if there is such a value without breaking functionality. null values should be seen as both +/- infinity, i.e. containsBetween(null, o) should return containsBefore(o) and containsBetween(o, null) should return containsAfter(o) containsBetween should take arguments IN ORDER, i.e. o1 <= o2; behaviour where o2 < o1 is undefined.

Specified by:

mayRejectBetween in interface FilterPartialOrder<E>

Parameters:

lb - the lower bound of the range to check

lbInclusive - if the lower bound should be taken as inclusive

ub - the upper bound of the range to check

ubInclusive - if the upper bound should be taken as inclusive

cmp - the partial order

Returns:

true, if there may exists a value V such that lb <(/<=) V <(/<=) ub and accept(V, cmp) == false

get

public static <E> AcceptEqual<E> get(E than)

Constructs a new filter accepting only values equal to the one provided, using default object equality. The filter implements both Filter and FilterPartialOrder.

Parameters:

than - value to accept

get

public static <E> AcceptEqual<E> get(E than,
                                     Equality<? super E> equality)

Constructs a new filter accepting only values equal to the one provided, using the provided definition of equality. The filter implements both Filter and FilterPartialOrder.

Parameters:

than - value to accept

equality - the definition of equality

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object