Package org.apache.commons.functor.core.comparator

Class IsWithinRange<A extends java.lang.Comparable<A>>

  • Type Parameters:
    A - the predicate argument type.
    All Implemented Interfaces:
    java.io.Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>
    public class IsWithinRange<A extends java.lang.Comparable<A>>
extends java.lang.Object
implements UnaryPredicate<A>, java.io.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:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int BASE_HASH_CODE
      Base Hashcode.
      private A max
      The maximum value of the range.
      private A min
      The minimum value of the range.
      private static int NAME_HASH_CODE
      Hashcode of the name of this Predicate.
      private static 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.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 java.lang.Comparable<A>>
      IsWithinRange<A>      		 instance​(A min, A max)
      Obtain an IsWithinRange instance.
      boolean test​(A o)
      Evaluate this predicate.
      java.lang.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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        serialVersionUID declaration.
        See Also:
        Constant Field Values

      • NAME_HASH_CODE

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

      • min

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

      • max

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

    • 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 java.lang.Comparable<A>>
        Parameters:
        o - the A object to test
        Returns:
        the result of this test

      • equals

        public final boolean equals​(java.lang.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 java.lang.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 java.lang.Object
        Returns:
        a hash code for this functor
        See Also:
        Functor.equals(java.lang.Object)

      • toString

        public java.lang.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 java.lang.Object
        Returns:
        a human readable description of this functor

      • instance

        public static <A extends java.lang.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