ForClosure documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

org.apache.commons.collections.functors

Class ForClosure

Tab mode

All derived types

public class ForClosure
implements Closure, Serializable

Closure implementation that calls another closure n times, like a for loop.

SinceCommons Co

Version$Revision:

AuthorStephen Colebourne

Wiki javadoc Use textile entry format.

Add your comments here.

Constructor Summary
ForClosure( int count, Closure closure ) Constructor that performs no validation.

Method Summary
void	execute( Object input ) Executes the closure `count` times.
Closure	getClosure() Gets the closure.
int	getCount() Gets the count.
static Closure	getInstance( int count, Closure closure ) Factory method that performs validation.

Methods inherited from java.langObject
clone () equals (Object) finalize () getClass () hashCode () notify () notifyAll () toString () wait (long) wait (long, int) wait ()

Constructor Detail

ForClosure

public ForClosure ( int count, Closure closure )

Constructor that performs no validation. Use getInstance if you want that.

Parameters

Type	Name	Description
int	count	the number of times to execute the closure
Closure	closure	the closure to execute, not null

Wiki javadoc Use textile entry format.

Add your comments here.

Method Detail

execute

public void execute ( Object input )

Executes the closure count times.

Implements method in Closure

Parameters

Type	Name	Description
Object	input	the input object

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

getClosure

public Closure getClosure ( )

Gets the closure.

Since: Commons Co

Wiki javadoc Use textile entry format.

Add your comments here.

getCount

public int getCount ( )

Gets the count.

Since: Commons Co

Wiki javadoc Use textile entry format.

Add your comments here.

getInstance

public static Closure getInstance ( int count, Closure closure )

Factory method that performs validation.

A null closure or zero count returns the NOPClosure. A count of one returns the specified closure.

Parameters

Type	Name	Description
int	count	the number of times to execute the closure
Closure	closure	the closure to execute, not null

Wiki javadoc Use textile entry format.

Add your comments here.