Class Max<T>

java.lang.Object
org.apache.commons.functor.core.comparator.Max<T>
Type Parameters:
T - the binary function arguments and return types.
All Implemented Interfaces:
Serializable, BinaryFunction<T,T,T>, BinaryFunctor<T,T>, Functor
public final class Max<T> extends Object implements BinaryFunction<T,T,T>, Serializable
Adapts a Comparator to the BinaryFunction interface.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • INSTANCE

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

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • comparator

      private final Comparator<T> comparator
      The wrapped comparator.

  • Constructor Details

    • Max

      public Max()
      Create a new Max.

    • Max

      public Max(Comparator<T> comparator)
      Create a new Max.
      Parameters:
      comparator - Comparator to use

  • Method Details

    • evaluate

      public T evaluate(T left, T right)
      Evaluate this function.
      Specified by:
      evaluate in interface BinaryFunction<T,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 T result of this function 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(Max<?> that)
      Learn whether another Max is equal to this.
      Parameters:
      that - Max 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<?>> Max<T> instance()
      Get a Max instance.
      Type Parameters:
      T - the binary function arguments and return types.
      Returns:
      Max

    • instance

      public static <T extends Comparable<?>> UnaryFunction<T,T> instance(T right)
      Get a Max UnaryFunction.
      Type Parameters:
      T - the binary function arguments and return types.
      Parameters:
      right - the right side argument of the Max function
      Returns:
      UnaryFunctioninvalid input: '<'T, T>