com.scriptbasic.interfaces

Interface Subroutine

All Known Implementing Classes:

Engine.Sub

public interface Subroutine

Interface to manage a BASIC subroutine. An instance of this interface can be acquired calling the method EngineApi.getSubroutine(String). It is also possible to get all the subroutines calling the method EngineApi.getSubroutines().

Author:

Peter Verhas

Method Summary

Methods

Modifier and Type	Method and Description
Object	call(Object... args) Call the subroutine.
String	getName() Get the name of the subroutine.
int	getNumberOfArguments()

Method Detail

getNumberOfArguments

int getNumberOfArguments()

Returns:

the number of arguments the subroutine expects when invoked

getName

String getName()

Get the name of the subroutine. Even though the instance of the interface is usually acquired knowing the name of the subroutine this method can be used to access this information.

Returns:

the name of the subroutine

call

Object call(Object... args)
            throws ScriptBasicException

Call the subroutine.

Parameters:

args - the arguments passed to the subroutine

Returns:

the return value of the subroutine

Throws:

ScriptBasicException - when an BASIC error happens during the execution of the subroutine