Class UntilGenerate<E>

java.lang.Object

org.apache.commons.functor.generator.BaseGenerator<E>

org.apache.commons.functor.generator.UntilGenerate<E>

Type Parameters:

E - the type of elements held in this generator.

All Implemented Interfaces:

Generator<E>

public class UntilGenerate<E>
extends BaseGenerator<E>

Wrap another Generator such that run(UnaryProcedure) terminates once a condition has been satisfied.

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
private final UnaryPredicate<? super E>	test	The condition has to verified in order to execute the generation.

Constructor Summary

Constructors

Constructor	Description
UntilGenerate(UnaryPredicate<? super E> test, Generator<? extends E> wrapped)	Create a new UntilGenerate.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Generator<? extends E>	getWrappedGenerator()	Get the generator that is being wrapped.
int	hashCode()
void	run(UnaryProcedure<? super E> proc)	Generators must implement this method.

Methods inherited from class BaseGenerator

isStopped, stop, to, to, toCollection

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

test

private final UnaryPredicate<? super E> test

The condition has to verified in order to execute the generation.

Constructor Details

UntilGenerate

public UntilGenerate(UnaryPredicate<? super E> test,
 Generator<? extends E> wrapped)

Create a new UntilGenerate.

Parameters:

test - UnaryPredicate

wrapped - Generator

Method Details

run

public void run(UnaryProcedure<? super E> proc)

Generators must implement this method.

Parameters:

proc - UnaryProcedure to run

getWrappedGenerator

protected Generator<? extends E> getWrappedGenerator()

Get the generator that is being wrapped.

Overrides:

getWrappedGenerator in class BaseGenerator<E>

Returns:

Generator

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object