scriptinterface

Interface SignatureInterface

All Superinterfaces:

StringRepresentation

All Known Implementing Classes:

DefaultSignature

public interface SignatureInterface
extends StringRepresentation

Parser for signatures which are given as string.

Method Summary

Modifier and Type	Method and Description
ExecutionError	createSignature(java.lang.String signatureString, ScriptSystemInterface<?,?> scriptSystem) Parses the given string and extracts key, parameters etc.
java.lang.String[]	getKeyArray() Returns the main key and the aliases as an array.
java.lang.String	getKeysAsString() Returns the main key and the aliases separated by a |.
java.lang.String	getMainKey() Returns the main key of the signature.
ParameterTuple	getParameterTuple() Returns the parameter tuple, including parameter keys, types and default values.
java.lang.String	getReturnValueAsString() Returns the string representation of the return type, whereas no return type yields "void".

Methods inherited from interface global.StringRepresentation

getStringRepresentation

Method Detail

createSignature

ExecutionError createSignature(java.lang.String signatureString,
                               ScriptSystemInterface<?,?> scriptSystem)

Parses the given string and extracts key, parameters etc. to store it and making it easy to access.

Parameters:

signatureString - the string to parse.

scriptSystem - the script system to calculate default values.

Returns:

null, if no error occurs. The error otherwise.

getParameterTuple

ParameterTuple getParameterTuple()

Returns the parameter tuple, including parameter keys, types and default values.

Returns:

the parameter tuple.

getMainKey

java.lang.String getMainKey()

Returns the main key of the signature.

Returns:

the main key.

getKeysAsString

java.lang.String getKeysAsString()

Returns the main key and the aliases separated by a |.

Returns:

the main key and the aliases.

getReturnValueAsString

java.lang.String getReturnValueAsString()

Returns the string representation of the return type, whereas no return type yields "void".

Returns:

the string representation of the return type.

getKeyArray

java.lang.String[] getKeyArray()

Returns the main key and the aliases as an array.

Returns:

the main key and the aliases.