Class BinaryFunctionUnaryFunction<A,T>

java.lang.Object
org.apache.commons.functor.adapter.BinaryFunctionUnaryFunction<A,T>
Type Parameters:
A - the argument type.
T - the returned value type.
All Implemented Interfaces:
Functor, UnaryFunction<A,T>, UnaryFunctor<A>
public final class BinaryFunctionUnaryFunction<A,T> extends Object implements UnaryFunction<A,T>
Adapts a BinaryFunction as a UnaryFunction by sending the same argument to both sides of the BinaryFunction. It sounds nonsensical, but using Composite functions, can be made to do something useful.
Version:
$Revision$ $Date$

  • Field Details

    • function

      private final BinaryFunction<? super A, ? super A, ? extends T> function
      The adapted function.

  • Constructor Details

    • BinaryFunctionUnaryFunction

      public BinaryFunctionUnaryFunction(BinaryFunction<? super A, ? super A, ? extends T> function)
      Create a new BinaryFunctionUnaryFunction.
      Parameters:
      function - to adapt

  • Method Details

    • evaluate

      public T evaluate(A obj)
      Evaluate this function.
      Specified by:
      evaluate in interface UnaryFunction<A,T>
      Parameters:
      obj - the A object to evaluate
      Returns:
      the T result of this evaluation

    • equals

      public boolean equals(Object obj)
      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:
      obj - 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(BinaryFunctionUnaryFunction<?,?> that)
      Learn whether another BinaryFunctionUnaryFunction is equal to this.
      Parameters:
      that - BinaryFunctionUnaryFunction to check
      Returns:
      whether equal

    • 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

    • adapt

      public static <A,T> UnaryFunction<A,T> adapt(BinaryFunction<? super A, ? super A, ? extends T> function)
      Adapt a BinaryFunction as a UnaryFunction.
      Type Parameters:
      A - input type
      T - result type
      Parameters:
      function - to adapt
      Returns:
      UnaryFunctioninvalid input: '<'A, T>