org.apache.commons.functor.core.composite
Class BinarySequence<L,R>

java.lang.Object
  org.apache.commons.functor.core.composite.BinarySequence<L,R>

All Implemented Interfaces:

java.io.Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor

public class BinarySequence<L,R>
extends java.lang.Object
implements BinaryProcedure<L,R>, java.io.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: 665786 $ $Date: 2008-06-09 12:17:39 -0500 (Mon, 09 Jun 2008) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

BinarySequence()
Create a new BinarySequence.

BinarySequence(BinaryProcedure<? super L,? super R> p)
Create a new BinarySequence.

BinarySequence(BinaryProcedure<? super L,? super R> p, BinaryProcedure<? super L,? super R> q)
Create a new BinarySequence.

Method Summary

boolean	equals(BinarySequence<?,?> that) Learn whether another BinarySequence is equal to this.
boolean	equals(java.lang.Object that) Indicates whether some other object is "equal to" this functor.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
void	run(L left, R right) Execute this procedure.
BinarySequence<L,R>	then(BinaryProcedure<? super L,? super R> p) Fluently add a BinaryProcedure.
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

Constructor Detail

BinarySequence

public BinarySequence()

Create a new BinarySequence.

BinarySequence

public BinarySequence(BinaryProcedure<? super L,? super R> p)

Create a new BinarySequence.

Parameters:

p - BinaryProcedure to add

BinarySequence

public BinarySequence(BinaryProcedure<? super L,? super R> p,
                      BinaryProcedure<? super L,? super R> q)

Create a new BinarySequence.

Parameters:

p - BinaryProcedure to add

q - BinaryProcedure to add

Method Detail

then

public BinarySequence<L,R> then(BinaryProcedure<? super L,? super R> p)

Fluently add a BinaryProcedure.

Parameters:

p - BinaryProcedure to add

Returns:

this

run

public 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 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(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 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