WhileGenerate

java.lang.Object
- org.apache.commons.functor.generator.BaseGenerator<E>
- - org.apache.commons.functor.generator.WhileGenerate<E>

Type Parameters:

E - the type of elements held in this generator.

All Implemented Interfaces:

Generator<E>
```
public class WhileGenerate<E>
extends BaseGenerator<E>
```
Wrap another Generator such that run(UnaryProcedure) continues as long as a condition is true (test before).

Version:

$Revision$ $Date$

Field Summary

Fields
Modifier and Type Field Description

private UnaryPredicate<? super E> test
The condition has to verified in order to execute the generation.

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.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 org.apache.commons.functor.generator.BaseGenerator
isStopped, stop, to, to, toCollection

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - test
```
private final UnaryPredicate<? super E> test
```
    The condition has to verified in order to execute the generation.
- Constructor Detail
  - WhileGenerate
```
public WhileGenerate(UnaryPredicate<? super E> test,
                     Generator<? extends E> wrapped)
```
    Create a new WhileGenerate.
    
    Parameters:
    
    test - UnaryPredicate
    
    wrapped - Generator
- Method Detail
  - 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(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object