net.termer.rtflc.runtime

Interface RtflFunction

All Known Implementing Classes:

InstructionFunction, RtflFunctionBuilder.JavaMethodFunction

public interface RtflFunction

Interface for defining functions

Since:

1.0

Method Summary

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

Method Detail

run

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

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.

Parameters:

args - the arguments provided to this function

runtime - 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

Since:

1.0