Class IsGreaterThanOrEqual<T>

java.lang.Object
org.apache.commons.functor.core.comparator.IsGreaterThanOrEqual<T>
Type Parameters:
T - the binary predicate input types
All Implemented Interfaces:
Serializable, BinaryFunctor<T,T>, BinaryPredicate<T,T>, Functor
public final class IsGreaterThanOrEqual<T> extends Object implements BinaryPredicate<T,T>, Serializable
A BinaryPredicate that tests true iff the left argument is greater than or equal to the right argument under the specified Comparator. When no (or a null Comparator is specified, a Comparable Comparator is used.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • INSTANCE

      public static final IsGreaterThanOrEqual<Comparable<?>> INSTANCE
      Basic IsGreaterThanOrEqual instance.

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • comparator

      private final Comparator<? super T> comparator
      The wrapped comparator.

  • Constructor Details

    • IsGreaterThanOrEqual

      public IsGreaterThanOrEqual()
      Construct a IsGreaterThanOrEqual predicate for Comparables.

    • IsGreaterThanOrEqual

      public IsGreaterThanOrEqual(Comparator<? super T> comparator)
      Construct a IsGreaterThanOrEqual predicate for the given Comparator.
      Parameters:
      comparator - the Comparator, when null, a Comparator for Comparables will be used.

  • Method Details

    • test

      public boolean test(T left, T right)
      Return true iff the left parameter is greater than or equal to the right parameter under my current Comparator. Evaluate this predicate.
      Specified by:
      test in interface BinaryPredicate<T,T>
      Parameters:
      left - the L element of the ordered pair of arguments
      right - the R element of the ordered pair of arguments
      Returns:
      the result of this test for the given arguments

    • equals

      public boolean equals(Object that)
      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:
      that - 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:

    • equals

      public boolean equals(IsGreaterThanOrEqual<?> that)
      Learn whether another IsGreaterThanOrEqual is equal to this.
      Parameters:
      that - IsGreaterThanOrEqual to test
      Returns:
      boolean

    • 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 <T extends Comparable<?>> IsGreaterThanOrEqual<T> instance()
      Get a typed IsGreaterThanOrEqual instance.
      Type Parameters:
      T - the binary predicate input types
      Returns:
      IsGreaterThanOrEqual

    • instance

      public static <T extends Comparable<?>> UnaryPredicate<T> instance(T right)
      Get an IsGreaterThanOrEqual UnaryPredicate.
      Type Parameters:
      T - the binary predicate input types
      Parameters:
      right - the right side object of the IsGreaterThanOrEqual comparison
      Returns:
      UnaryPredicate