com.sun.slamd.scripting.engine
Class WhileInstruction

java.lang.Object
  com.sun.slamd.scripting.engine.Instruction
      com.sun.slamd.scripting.engine.WhileInstruction

public class WhileInstruction

extends Instruction

This class defines an instruction that will be executed as long as the specified condition is true.

Constructor Summary

WhileInstruction(int lineNumber, Argument condition, Instruction instruction)
Creates a new while instruction.

Method Summary

void	debugExecute(JobClass jobThread) Performs the function associated with this instruction, writing debug information about its execution to the client's message writer using the writeVerbose method.
void	execute(JobClass jobThread) Performs the function associated with this instruction.
Argument	getCondition() Retrieves the condition for this while instruction.
Instruction	getInstruction() Retrieves the instruction that will be executed.
java.lang.String	toString(int indent) Retrieves a string representation of this instruction as could be found in a script file.

Methods inherited from class com.sun.slamd.scripting.engine.Instruction

getLineNumber, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WhileInstruction

public WhileInstruction(int lineNumber,
                        Argument condition,
                        Instruction instruction)

Creates a new while instruction.

Parameters:

lineNumber - The line number of the script on which this while instruction begins.

condition - The condition that will be evaluated to determine whether the instruction will be executed another time.

instruction - The instruction to execute as long as the condition evaluates to true.

Method Detail

getCondition

public Argument getCondition()

Retrieves the condition for this while instruction.

Returns:

The condition for this while instruction.

getInstruction

public Instruction getInstruction()

Retrieves the instruction that will be executed.

Returns:

The instruction that will be executed.

execute

public void execute(JobClass jobThread)
             throws ScriptException

Performs the function associated with this instruction.

Specified by:

execute in class Instruction

Parameters:

jobThread - The job thread that will be executing the script.

Throws:

ScriptException - If a problem occurs while processing this instruction.

debugExecute

public void debugExecute(JobClass jobThread)
                  throws ScriptException

Performs the function associated with this instruction, writing debug information about its execution to the client's message writer using the writeVerbose method.

Specified by:

debugExecute in class Instruction

Parameters:

jobThread - The job thread that will be executing the script.

Throws:

ScriptException - If a problem occurs while processing this instruction.

toString

public java.lang.String toString(int indent)

Retrieves a string representation of this instruction as could be found in a script file. It may consist of multiple lines if necessary.

Specified by:

toString in class Instruction

Parameters:

indent - The number of spaces to indent the output.

Returns:

A string representation of this instruction as could be found in a script file.