net.termer.rtflc.runtime

Class InstructionFunction

java.lang.Object

net.termer.rtflc.runtime.InstructionFunction

All Implemented Interfaces:

RtflFunction

public class InstructionFunction
extends java.lang.Object
implements RtflFunction

Function that contains RtflInstruction objects to execute

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
InstructionFunction(RtflInstruction[] instructions) Instantiates a new InstructionFunction with the provided instructions
InstructionFunction(RtflInstruction[] instructions, java.lang.String[] argumentNames) Instantiates a new InstructionFunction with the provided instructions and argument names

Method Summary

Modifier and Type	Method and Description
RtflType	run(RtflType[] args, RtflRuntime rt, Scope scope) Runs the function in the provided scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstructionFunction

public InstructionFunction(RtflInstruction[] instructions)

Instantiates a new InstructionFunction with the provided instructions

Parameters:

instructions - the instructions to store in this function

Since:

1.0

InstructionFunction

public InstructionFunction(RtflInstruction[] instructions,
                           java.lang.String[] argumentNames)

Instantiates a new InstructionFunction with the provided instructions and argument names

Parameters:

instructions - the instructions to store in this function

argumentNames - The names of this function's arguments

Since:

1.0

Method Detail

run

public RtflType run(RtflType[] args,
                    RtflRuntime rt,
                    Scope scope)
             throws RuntimeException

Description copied from interface: RtflFunction

Runs the function in the provided scope. Using the current scope for execution would be akin to simply dropping the function code into the current code block. For distinct scoping inside of this function, you should use the output of scope.descend() for this method.

Specified by:

run in interface RtflFunction

Parameters:

args - the arguments provided to this function

rt - the Runtime to use for executing this function

scope - the scope in which to execute this function

Returns:

the return value of this function. Should be NullType if none.

Throws:

RuntimeException - if a runtime error occurs during the execution of this function