Class CompositeUnaryProcedure<A>

java.lang.Object
org.apache.commons.functor.core.composite.CompositeUnaryProcedure<A>
Type Parameters:
A - the procedure argument type.
All Implemented Interfaces:
Serializable, Functor, UnaryFunctor<A>, UnaryProcedure<A>
public final class CompositeUnaryProcedure<A> extends Object implements UnaryProcedure<A>, 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:

  • Field Details

  • Constructor Details

    • CompositeUnaryProcedure

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

    • CompositeUnaryProcedure

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

  • Method Details

    • 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(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 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:

    • 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 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