Package org.apache.commons.functor.adapter

Class BoundProcedure

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Runnable, Functor, NullaryFunctor, Procedure
    public final class BoundProcedure
extends java.lang.Object
implements Procedure, java.io.Serializable
    Adapts a UnaryProcedure to the Procedure interface using a constant unary 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

    • Constructor Summary

      Constructors 
      Constructor Description
      BoundProcedure​(UnaryProcedure<? super A> procedure, A arg)
      Create a new BoundProcedure instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static <A> BoundProcedure bind​(UnaryProcedure<? super A> procedure, A arg)
      Adapt the given, possibly-null, UnaryProcedure to the Procedure interface by binding the specified Object as a constant argument.
      boolean equals​(java.lang.Object that)
      Indicates whether some other object is "equal to" this functor.
      boolean equals​(BoundProcedure that)
      Learn whether a given BoundProcedure 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

      • param

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

    • Constructor Detail

      • BoundProcedure

        public BoundProcedure​(UnaryProcedure<? super A> procedure,
                      A arg)
        Create a new BoundProcedure instance.
        Type Parameters:
        A - arg type
        Parameters:
        procedure - the procedure to adapt
        arg - the constant 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​(BoundProcedure that)
        Learn whether a given BoundProcedure is equal to this.
        Parameters:
        that - the BoundProcedure 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 <A> BoundProcedure bind​(UnaryProcedure<? super A> procedure,
                                      A arg)
        Adapt the given, possibly-null, UnaryProcedure to the Procedure interface by binding the specified Object as a constant argument. When the given UnaryProcedure is null, returns null.
        Type Parameters:
        A - arg type
        Parameters:
        procedure - the possibly-null UnaryProcedure to adapt
        arg - the object to bind as a constant argument
        Returns:
        a BoundProcedure wrapping the given UnaryProcedure, or null if the given UnaryProcedure is null