Class IsWithinRange<A extends Comparable<A>>

java.lang.Object
org.apache.commons.functor.core.comparator.IsWithinRange<A>
Type Parameters:
A - the predicate argument type.
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$ $Date$
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final int
    BASE_HASH_CODE
    Base Hashcode.
    private final A
    max
    The maximum value of the range.
    private final A
    min
    The minimum value of the range.
    private static final int
    NAME_HASH_CODE
    Hashcode of the name of this Predicate.
    private static final long
    serialVersionUID
    serialVersionUID declaration.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    final 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.
    final boolean
    test(A o)
    Evaluate this predicate.
    String
    toString()
    Returns a human readable description of this functor.

    Methods inherited from class Object

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

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • NAME_HASH_CODE

      private static final int NAME_HASH_CODE
      Hashcode of the name of this Predicate.

    • BASE_HASH_CODE

      private static final int BASE_HASH_CODE
      Base Hashcode.
      See Also:

    • min

      private final A extends Comparable<A> min
      The minimum value of the range.

    • max

      private final A extends Comparable<A> max
      The maximum value of the range.

  • Constructor Details

    • 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 Details

    • 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:

    • 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:

    • 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 - the argument type.
      Parameters:
      min - the min value
      max - the max value
      Returns:
      IsWithinRange