org.apache.commons.functor.core.comparator
Class IsWithinRange<A extends Comparable<A>>

java.lang.Object
  org.apache.commons.functor.core.comparator.IsWithinRange<A>

All Implemented Interfaces:

Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>

public class IsWithinRange<A extends Comparable<A>>
extends Object
implements UnaryPredicate<A>, Serializable

A UnaryPredicate that tests whether a Comparable object is within a range. The range is defined in the constructor.

Since:

1.0

Version:

$Revision: 1171154 $ $Date: 2011-09-15 17:58:38 +0200 (Thu, 15 Sep 2011) $

Author:

Jason Horman (jason@jhorman.org)

See Also:

Serialized Form

Constructor Summary

IsWithinRange(A min, A max)
Create a new IsWithinRange by passing in the range that will be used in the test(A).

Method Summary

boolean	equals(Object o) Indicates whether some other object is "equal to" this functor.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
static <A extends Comparable<A>> IsWithinRange<A>	instance(A min, A max) Obtain an IsWithinRange instance.
boolean	test(A o) Evaluate this predicate.
String	toString() Returns a human readable description of this functor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IsWithinRange

public IsWithinRange(A min,
                     A max)

Create a new IsWithinRange by passing in the range that will be used in the test(A).

Parameters:

min - Comparable

max - Comparable

Method Detail

test

public final boolean test(A o)

Evaluate this predicate. Test if the passed in object is within the specified range.

Specified by:

test in interface UnaryPredicate<A extends Comparable<A>>

Parameters:

o - the A object to test

Returns:

the result of this test

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this functor. This method must adhere to general Object.equals contract. Additionally, this method can return true only if the specified Object implements the same functor interface and is known to produce the same results and/or side-effects for the same arguments (if any).

While implementators are strongly encouraged to override the default Object implementation of this method, note that the default Object implementation does in fact adhere to the functor equals contract.

Specified by:

equals in interface Functor

Overrides:

equals in class Object

Parameters:

o - the object to compare this functor to

Returns:

true iff the given object implements this functor interface, and is known to produce the same results and/or side-effects for the same arguments (if any).

See Also:

Functor.hashCode()

hashCode

public int hashCode()

Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

hashCode in interface Functor

Overrides:

hashCode in class Object

Returns:

a hash code for this functor

See Also:

Functor.equals(java.lang.Object)

toString

public String toString()

Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

toString in interface Functor

Overrides:

toString in class Object

Returns:

a human readable description of this functor

instance

public static <A extends Comparable<A>> IsWithinRange<A> instance(A min,
                                                                  A max)

Obtain an IsWithinRange instance.

Type Parameters:

A -

Parameters:

min - A

max - A

Returns:

IsWithinRange