com.sun.slamd.scripting.engine
Class AssignmentInstruction

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

public class AssignmentInstruction
extends Instruction

This class defines an instruction that will assign the value of an argument to a variable. The variable to which the argument value is assigned must have the same type as the argument value.

Author:

Neil A. Wilson

Constructor Summary

AssignmentInstruction(int lineNumber, Variable variable, Argument argument)
Creates a new assignment instruction with the specified variable and argument.

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	getArgument() Retrieves the argument whose value will be assigned to the variable.
Variable	getVariable() Retrieves the variable to which the argument value will be assigned.
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

AssignmentInstruction

public AssignmentInstruction(int lineNumber,
                             Variable variable,
                             Argument argument)

Creates a new assignment instruction with the specified variable and argument.

Parameters:

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

variable - The variable that is to be assigned the value of the argument.

argument - The argument whose value is to be assigned to the variable.

Method Detail

getVariable

public Variable getVariable()

Retrieves the variable to which the argument value will be assigned.

Returns:

The variable to which the argument value will be assigned.

getArgument

public Argument getArgument()

Retrieves the argument whose value will be assigned to the variable.

Returns:

The argument whose value will be assigned to the variable.

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.