Class BinarySequence<L,R>

java.lang.Object
org.apache.commons.functor.core.composite.BinarySequence<L,R>
Type Parameters:
L - the procedure left argument type.
R - the procedure right argument type.
All Implemented Interfaces:
Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor
public class BinarySequence<L,R> extends Object implements BinaryProcedure<L,R>, Serializable
A BinaryProcedure that runs an ordered sequence of BinaryProcedures. When the sequence is empty, this procedure is does nothing.

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

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • list

      private final List<BinaryProcedure<? super L, ? super R>> list
      A list where storing all the procedures references.

  • Constructor Details

    • BinarySequence

      public BinarySequence()
      Create a new BinarySequence.

    • BinarySequence

      public BinarySequence(BinaryProcedure<? super L, ? super R>... procedures)
      Create a new BinarySequence instance.
      Parameters:
      procedures - to run sequentially

    • BinarySequence

      public BinarySequence(Iterable<BinaryProcedure<? super L, ? super R>> procedures)
      Create a new BinarySequence instance.
      Parameters:
      procedures - to run sequentially

  • Method Details

    • then

      public final BinarySequence<L,R> then(BinaryProcedure<? super L, ? super R> p)
      Fluently add a BinaryProcedure.
      Parameters:
      p - BinaryProcedure to add
      Returns:
      this

    • run

      public final void run(L left, R right)
      Execute this procedure.
      Specified by:
      run in interface BinaryProcedure<L,R>
      Parameters:
      left - the L element of the ordered pair of arguments
      right - the R element of the ordered pair of arguments

    • equals

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