com.sun.slamd.scripting.engine
Class BreakInstruction

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

public class BreakInstruction
extends Instruction

This class defines an instruction that will cause the scripting engine to immediately break out of a loop and resume execution at the first instruction after the loop.

Author:

Neil A. Wilson

Constructor Summary

BreakInstruction(int lineNumber)
Creates a new break 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.
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

BreakInstruction

public BreakInstruction(int lineNumber)

Creates a new break instruction.

Parameters:

lineNumber - The line number on which the if statement occurs in the script.

Method Detail

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.