com.hcl.domino.misc

Class Loop

java.lang.Object

com.hcl.domino.misc.Loop

public class Loop
extends Object

Helper method to control a forEach loop, e.g. to stop the loop or get the current offset

Constructor Summary

Constructors

Constructor and Description
Loop()

Method Summary

Modifier and Type	Method and Description
int	getIndex() Returns the current loop index.
boolean	isFirst() Returns true if the current element is the first of the collection
boolean	isLast() Returns true if the current element is the last of the collection
boolean	isStopped() Returns true if forEach loop should be stopped
protected void	setIndex(int index) Internal method to change current index
protected void	setIsLast() Internal method to change isLast flag
void	stop() Call this method to stop a forEach loop

Methods inherited from class java.lang.Object

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

Constructor Detail

Loop

public Loop()

Method Detail

stop

public void stop()

Call this method to stop a forEach loop

isStopped

public boolean isStopped()

Returns true if forEach loop should be stopped

Returns:

true if stopped

isLast

public boolean isLast()

Returns true if the current element is the last of the collection

Returns:

true if last

isFirst

public boolean isFirst()

Returns true if the current element is the first of the collection

Returns:

true if first

getIndex

public int getIndex()

Returns the current loop index. If skip(int) is used in the forEach loop, the first loop index is the skip offset value

Returns:

index

setIsLast

protected void setIsLast()

Internal method to change isLast flag

setIndex

protected void setIndex(int index)

Internal method to change current index

Parameters:

index - new index