Package com.tameif.tame.lang

Class Operation

java.lang.Object

com.tameif.tame.lang.Operation

All Implemented Interfaces:

CallableType, Saveable

public class Operation
extends java.lang.Object
implements CallableType, Saveable

A single low-level machine operation.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method and Description
static Operation	create(TAMEOperation operation) Creates an operation.
static Operation	create(TAMEOperation operation, Block conditionalBlock, Block successBlock) Creates an operation with a conditional and success block.
static Operation	create(TAMEOperation operation, Block conditionalBlock, Block successBlock, Block failureBlock) Creates an operation with a conditional, success, and failure block.
static Operation	create(TAMEOperation operation, Block initializationBlock, Block conditionalBlock, Block stepBlock, Block successBlock) Creates a operation with an initializer, conditional, step, success, and failure block.
static Operation	create(TAMEOperation operation, Value operand0) Creates an operation with an operand.
static Operation	create(TAMEOperation operation, Value operand0, Value operand1) Creates an operation with operands.
static Operation	create(java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
void	execute(TAMERequest request, TAMEResponse response, ValueSet blockLocal) Executes something that can change the request and response.
Block	getConditionalBlock() Gets the conditional assessment block, if any.
Block	getFailureBlock() Gets the failure control block, if any.
Block	getInitBlock() Gets the initializer block, if any.
Value	getOperand0() Gets the first operand, if any.
Value	getOperand1() Gets the second operand, if any.
TAMEOperation	getOperation() Gets the operation on this operation.
Block	getStepBlock() Gets the stepping control block, if any.
Block	getSuccessBlock() Gets the success control block, if any.
void	readBytes(java.io.InputStream in) Imports this object from bytes.
java.lang.String	toString()
void	writeBytes(java.io.OutputStream out) Exports this object to bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tameif.tame.lang.Saveable

fromBytes, toBytes

Method Detail

create

public static Operation create(TAMEOperation operation)

Creates an operation.

Parameters:

operation - the operation.

Returns:

the new operation.

create

public static Operation create(TAMEOperation operation,
                               Value operand0)

Creates an operation with an operand.

Parameters:

operation - the operation.

operand0 - the first operand.

Returns:

the new operation.

create

public static Operation create(TAMEOperation operation,
                               Value operand0,
                               Value operand1)

Creates an operation with operands.

Parameters:

operation - the operation.

operand0 - the first operand.

operand1 - the second operand.

Returns:

the new operation.

create

public static Operation create(TAMEOperation operation,
                               Block conditionalBlock,
                               Block successBlock)

Creates an operation with a conditional and success block.

Parameters:

operation - the operation.

conditionalBlock - the conditional block.

successBlock - the success block.

Returns:

the new operation.

create

public static Operation create(TAMEOperation operation,
                               Block conditionalBlock,
                               Block successBlock,
                               Block failureBlock)

Creates an operation with a conditional, success, and failure block.

Parameters:

operation - the operation.

conditionalBlock - the conditional block.

successBlock - the success block.

failureBlock - the failure block.

Returns:

the new operation.

create

public static Operation create(TAMEOperation operation,
                               Block initializationBlock,
                               Block conditionalBlock,
                               Block stepBlock,
                               Block successBlock)

Creates a operation with an initializer, conditional, step, success, and failure block.

Parameters:

operation - the operation.

initializationBlock - the init block.

conditionalBlock - the conditional block.

stepBlock - the step block.

successBlock - the success block.

Returns:

the new operation.

execute

public void execute(TAMERequest request,
                    TAMEResponse response,
                    ValueSet blockLocal)
             throws TAMEInterrupt

Description copied from interface: CallableType

Executes something that can change the request and response.

Specified by:

execute in interface CallableType

Parameters:

request - the request object.

response - the response object.

blockLocal - the block local variable bank.

Throws:

TAMEInterrupt - if an interrupt occurs.

getOperation

public TAMEOperation getOperation()

Gets the operation on this operation.

Returns:

the operation's encapsulated operation.

getOperand0

public Value getOperand0()

Gets the first operand, if any.

Returns:

the operand, or null if no operand.

getOperand1

public Value getOperand1()

Gets the second operand, if any.

Returns:

the operand, or null if no operand.

getInitBlock

public Block getInitBlock()

Gets the initializer block, if any.

Returns:

the block, or null if no block.

getConditionalBlock

public Block getConditionalBlock()

Gets the conditional assessment block, if any.

Returns:

the block, or null if no block.

getStepBlock

public Block getStepBlock()

Gets the stepping control block, if any.

Returns:

the block, or null if no block.

getSuccessBlock

public Block getSuccessBlock()

Gets the success control block, if any.

Returns:

the block, or null if no block.

getFailureBlock

public Block getFailureBlock()

Gets the failure control block, if any.

Returns:

the block, or null if no block.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static Operation create(java.io.InputStream in)
                        throws java.io.IOException

Creates this object from an input stream, expecting its byte representation.

Parameters:

in - the input stream to read from.

Returns:

the read object.

Throws:

java.io.IOException - if a read error occurs.

writeBytes

public void writeBytes(java.io.OutputStream out)
                throws java.io.IOException

Description copied from interface: Saveable

Exports this object to bytes.

Specified by:

writeBytes in interface Saveable

Parameters:

out - the output stream to write to.

Throws:

java.io.IOException - if a write problem occurs.

readBytes

public void readBytes(java.io.InputStream in)
               throws java.io.IOException

Description copied from interface: Saveable

Imports this object from bytes.

Specified by:

readBytes in interface Saveable

Parameters:

in - the input stream to read from.

Throws:

java.io.IOException - if a read problem occurs.