WhileClosure (Apache Commons Collections 4.0 API)

java.lang.Object
- org.apache.commons.collections4.functors.WhileClosure<E>

All Implemented Interfaces:

Serializable, Closure<E>
```
public class WhileClosure<E>
extends Object
implements Closure<E>, Serializable
```
Closure implementation that executes a closure repeatedly until a condition is met, like a do-while or while loop.

Since:

3.0

Version:

$Id: WhileClosure.html 972421 2015-11-14 20:00:04Z tn $

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`WhileClosure(Predicate<? super E> predicate, Closure<? super E> closure, boolean doLoop)` Constructor that performs no validation.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute(E input)` Executes the closure until the predicate is false.
`Closure<? super E>`	`getClosure()` Gets the closure.
`Predicate<? super E>`	`getPredicate()` Gets the predicate in use.
`boolean`	`isDoLoop()` Is the loop a do-while loop.
`static <E> Closure<E>`	`whileClosure(Predicate<? super E> predicate, Closure<? super E> closure, boolean doLoop)` Factory method that performs validation.

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

- Constructor Detail
  - WhileClosure
```
public WhileClosure(Predicate<? super E> predicate,
            Closure<? super E> closure,
            boolean doLoop)
```
    Constructor that performs no validation. Use whileClosure if you want that.
    
    Parameters:
    predicate - the predicate used to evaluate when the loop terminates, not null
    closure - the closure the execute, not null
    doLoop - true to act as a do-while loop, always executing the closure once
- Method Detail
  - whileClosure
```
public static <E> Closure<E> whileClosure(Predicate<? super E> predicate,
                          Closure<? super E> closure,
                          boolean doLoop)
```
    Factory method that performs validation.
    
    Type Parameters:
    E - the type that the closure acts on
    Parameters:
    predicate - the predicate used to evaluate when the loop terminates, not null
    closure - the closure the execute, not null
    doLoop - true to act as a do-while loop, always executing the closure once
    
    Returns:
    the while closure
    
    Throws:
    
    IllegalArgumentException - if the predicate or closure is null
  - execute
```
public void execute(E input)
```
    Executes the closure until the predicate is false.
    
    Specified by:
    
    execute in interface Closure<E>
    
    Parameters:
    input - the input object
  - getPredicate
```
public Predicate<? super E> getPredicate()
```
    Gets the predicate in use.
    
    Returns:
    the predicate
    Since:
    
    3.1
  - getClosure
```
public Closure<? super E> getClosure()
```
    Gets the closure.
    
    Returns:
    the closure
    Since:
    
    3.1
  - isDoLoop
```
public boolean isDoLoop()
```
    Is the loop a do-while loop.
    
    Returns:
    true is do-while, false if while
    Since:
    
    3.1

Class WhileClosure<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WhileClosure

Method Detail

whileClosure

execute

getPredicate

getClosure

isDoLoop