Package org.apache.commons.functor.adapter

Class FullyBoundProcedure

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Runnable, Functor, NullaryFunctor, Procedure
    public final class FullyBoundProcedure
extends java.lang.Object
implements Procedure, java.io.Serializable
    Adapts a BinaryProcedure to the Procedure interface using a constant left-side argument.

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

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Object left
      The left parameter to pass to procedure.
      private BinaryProcedure<java.lang.Object,​java.lang.Object> procedure
      The BinaryProcedure I'm wrapping.
      private java.lang.Object right
      The right parameter to pass to procedure.
      private static long serialVersionUID
      serialVersionUID declaration.

    • Constructor Summary

      Constructors 
      Constructor Description
      FullyBoundProcedure​(BinaryProcedure<? super L,​? super R> procedure, L left, R right)
      Create a new FullyBoundProcedure instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static <L,​R>
      FullyBoundProcedure      		 bind​(BinaryProcedure<? super L,​? super R> procedure, L left, R right)
      Adapt a BinaryProcedure to the Procedure interface.
      boolean equals​(java.lang.Object that)
      Indicates whether some other object is "equal to" this functor.
      boolean equals​(FullyBoundProcedure that)
      Learn whether another FullyBoundProcedure is equal to this.
      int hashCode()
      Returns a hash code for this functor adhering to the general Object.hashCode contract.
      void run()
      Execute this procedure.
      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

      • left

        private final java.lang.Object left
        The left parameter to pass to procedure.

      • right

        private final java.lang.Object right
        The right parameter to pass to procedure.

    • Constructor Detail

      • FullyBoundProcedure

        public FullyBoundProcedure​(BinaryProcedure<? super L,​? super R> procedure,
                           L left,
                           R right)
        Create a new FullyBoundProcedure instance.
        Type Parameters:
        L - left type
        R - right type
        Parameters:
        procedure - the procedure to adapt
        left - the left argument to use
        right - the right argument to use

    • Method Detail

      • run

        public void run()
        Execute this procedure.
        Specified by:
        run in interface Procedure
        Specified by:
        run in interface java.lang.Runnable

      • 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​(FullyBoundProcedure that)
        Learn whether another FullyBoundProcedure is equal to this.
        Parameters:
        that - FullyBoundProcedure 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

      • bind

        public static <L,​R> FullyBoundProcedure bind​(BinaryProcedure<? super L,​? super R> procedure,
                                                   L left,
                                                   R right)
        Adapt a BinaryProcedure to the Procedure interface.
        Type Parameters:
        L - left type
        R - right type
        Parameters:
        procedure - to adapt
        left - left side argument
        right - right side argument
        Returns:
        FullyBoundProcedure