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

Class Sequence

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Runnable, Functor, NullaryFunctor, Procedure
    public class Sequence
extends java.lang.Object
implements Procedure, java.io.Serializable
    A Procedure that runs an ordered sequence of Procedures. 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:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<Procedure> list
      The data structure where storing procedures sequence.
      private static long serialVersionUID
      serialVersionUID declaration.

    • Constructor Summary

      Constructors 
      Constructor Description
      Sequence()
      Create a new Sequence.
      Sequence​(java.lang.Iterable<Procedure> procedures)
      Create a new Sequence instance.
      Sequence​(Procedure... procedures)
      Create a new Sequence instance.

    • 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​(Sequence that)
      Learn whether a given Sequence 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.
      Sequence then​(Procedure p)
      Fluently add a 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

      • list

        private java.util.List<Procedure> list
        The data structure where storing procedures sequence.

    • Constructor Detail

      • Sequence

        public Sequence()
        Create a new Sequence.

      • Sequence

        public Sequence​(Procedure... procedures)
        Create a new Sequence instance.
        Parameters:
        procedures - to run sequentially

      • Sequence

        public Sequence​(java.lang.Iterable<Procedure> procedures)
        Create a new Sequence instance.
        Parameters:
        procedures - to run sequentially

    • Method Detail

      • then

        public final Sequence then​(Procedure p)
        Fluently add a Procedure.
        Parameters:
        p - Procedure to add
        Returns:
        this

      • run

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

      • equals

        public final 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​(Sequence that)
        Learn whether a given Sequence is equal to this.
        Parameters:
        that - Sequence 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