com.sun.slamd.scripting.engine
Class InstructionBlock

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

public class InstructionBlock

extends Instruction

This class defines a generic instruction block, which is simply a container that holds zero or more instructions to be executed as a single block.

Constructor Summary

InstructionBlock(int lineNumber, Instruction[] instructions)
Creates an instruction block that will execute the specified set of instructions.

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.
Instruction[]	getInstructions() Retrieves the set of instructions that will be executed in this instruction block.
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

InstructionBlock

public InstructionBlock(int lineNumber,
                        Instruction[] instructions)

Creates an instruction block that will execute the specified set of instructions.

Parameters:

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

instructions - The set of instructions to include in this instruction block.

Method Detail

getInstructions

public Instruction[] getInstructions()

Retrieves the set of instructions that will be executed in this instruction block.

Returns:

The set of instructions that will be executed in this instruction block.

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.