Package org.apache.commons.functor.core.composite

Class CompositeUnaryProcedure<A>

  • Type Parameters:
    A - the procedure argument type.
    All Implemented Interfaces:
    java.io.Serializable, Functor, UnaryFunctor<A>, UnaryProcedure<A>
    public final class CompositeUnaryProcedure<A>
extends java.lang.Object
implements UnaryProcedure<A>, java.io.Serializable
    A UnaryProcedure representing the composition of UnaryFunctions, "chaining" the output of one to the input of another. For example, 
    new CompositeUnaryProcedure(p).of(f)
    runs to p.run(f.evaluate(obj)), and 
    new CompositeUnaryProcedure(p).of(f).of(g)
    runs p.run(f.evaluate(g.evaluate(obj))).

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object that)
      Indicates whether some other object is "equal to" this functor.
      boolean equals​(CompositeUnaryProcedure<?> that)
      Learn whether another CompositeUnaryProcedure is equal to this.
      int hashCode()
      Returns a hash code for this functor adhering to the general Object.hashCode contract.
      <T> CompositeUnaryProcedure<T> of​(UnaryFunction<? super T,​? extends A> preceding)
      Fluently obtain a CompositeUnaryProcedure that runs our procedure against the result of the preceding function.
      void run​(A obj)
      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

      • function

        private final CompositeUnaryFunction<? super A,​java.lang.Object> function
        The adapted composite procedure.

    • Constructor Detail

      • CompositeUnaryProcedure

        public CompositeUnaryProcedure​(UnaryProcedure<? super A> procedure)
        Create a new CompositeUnaryProcedure.
        Parameters:
        procedure - final UnaryProcedure to run

      • CompositeUnaryProcedure

        private CompositeUnaryProcedure​(CompositeUnaryFunction<? super A,​java.lang.Object> function)
        Create a new CompositeUnaryProcedure.
        Parameters:
        function - final CompositeUnaryFunction to run

    • Method Detail

      • of

        public <T> CompositeUnaryProcedure<T> of​(UnaryFunction<? super T,​? extends A> preceding)
        Fluently obtain a CompositeUnaryProcedure that runs our procedure against the result of the preceding function.
        Type Parameters:
        T - the input function left argument and output procedure argument type
        Parameters:
        preceding - UnaryFunction
        Returns:
        CompositeUnaryProcedure

      • run

        public void run​(A obj)
        Execute this procedure.
        Specified by:
        run in interface UnaryProcedure<A>
        Parameters:
        obj - an A parameter to this execution

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