Package org.apache.commons.functor.adapter

Class BinaryProcedureBinaryFunction<L,​R,​T>

  • Type Parameters:
    L - the left argument type.
    R - the right argument type.
    T - the returned value type.
    All Implemented Interfaces:
    java.io.Serializable, BinaryFunction<L,​R,​T>, BinaryFunctor<L,​R>, Functor
    public final class BinaryProcedureBinaryFunction<L,​R,​T>
extends java.lang.Object
implements BinaryFunction<L,​R,​T>, java.io.Serializable
    Adapts a BinaryProcedure to the BinaryFunction interface by always returning null.

    Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying procedure is. Attempts to serialize an instance whose delegate is not Serializable will result in an exception.

    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Detail

      • BinaryProcedureBinaryFunction

        public BinaryProcedureBinaryFunction​(BinaryProcedure<? super L,​? super R> procedure)
        Create a new BinaryProcedureBinaryFunction.
        Parameters:
        procedure - to adapt as a BinaryFunction

    • Method Detail

      • evaluate

        public T evaluate​(L left,
                  R right)
        Evaluate this function.
        Specified by:
        evaluate in interface BinaryFunction<L,​R,​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​(java.lang.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 java.lang.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:
        Functor.hashCode()

      • equals

        public boolean equals​(BinaryProcedureBinaryFunction<?,​?,​?> that)
        Learn whether another BinaryProcedureBinaryFunction is equal to this.
        Parameters:
        that - the BinaryProcedureBinaryFunction 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 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

      • adapt

        public static <L,​R,​T> BinaryProcedureBinaryFunction<L,​R,​T> adapt​(BinaryProcedure<? super L,​? super R> procedure)
        Adapt the given, possibly-null, BinaryProcedure to the BinaryFunction interface. When the given BinaryProcedure is null, returns null.
        Type Parameters:
        L - the left argument type.
        R - the right argument type.
        T - the returned value type.
        Parameters:
        procedure - the possibly-null BinaryFunction to adapt
        Returns:
        a BinaryProcedureBinaryFunction wrapping the given BinaryFunction, or null if the given BinaryFunction is null