io.warp10.script.functions

Class WHILE

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.WHILE

All Implemented Interfaces:

WarpScriptStackFunction

public class WHILE
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Implements a 'While' loop 2: WHILE-macro 1: RUN-macro WHILE Macros are popped out of the stack. Step-1: WHILE-macro is evaluated, it is expected to leave a boolean on the top of the stack Step-2: Boolean is consumed Step-3: if boolean was true, eval RUN-macro and go to step 1, otherwise, stop

Constructor Summary

Constructors

Constructor and Description
WHILE(java.lang.String name)
WHILE(java.lang.String name, long maxtime)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WHILE

public WHILE(java.lang.String name)

WHILE

public WHILE(java.lang.String name,
             long maxtime)

Method Detail

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException