scriptinterface

Class DefaultSignature

java.lang.Object

scriptinterface.DefaultSignature

All Implemented Interfaces:

StringRepresentation, SignatureInterface

public class DefaultSignature
extends java.lang.Object
implements SignatureInterface

A default SignatureInterface implementation which extracts the information of a signature string and transforms it into an easy to access data structure.

Constructor Summary

Constructors

Constructor and Description
DefaultSignature()

Method Summary

Modifier and Type	Method and Description
ExecutionError	createSignature(java.lang.String signatureString, ScriptSystemInterface<?,?> scriptSystem) Initializes the signature according to the given string.
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.
ScriptType	getReturnValue() Returns the return type of the signature.
java.lang.String	getReturnValueAsString() Returns the string representation of the return type, whereas no return type yields "void".
java.lang.String	getStringRepresentation() Returns a user-readable string representation of the object.
boolean	isCreated() Tells whether or not this instance was initialized.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSignature

public DefaultSignature()

Method Detail

createSignature

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

Initializes the signature according to the given string. See the Graphana manual for informations about the Syntax. A script system must be given to evaluate the default values.

Specified by:

createSignature in interface SignatureInterface

Parameters:

signatureString - the string to parse.

scriptSystem - the script system to calculate default values.

Returns:

null, if no error occurs. The error otherwise.

getParameterTuple

public ParameterTuple getParameterTuple()

Description copied from interface: SignatureInterface

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

Specified by:

getParameterTuple in interface SignatureInterface

Returns:

the parameter tuple.

isCreated

public boolean isCreated()

Tells whether or not this instance was initialized.

Returns:

true if and only if createSignature(java.lang.String, scriptinterface.ScriptSystemInterface<?, ?>) was called successfully.

getKeysAsString

public java.lang.String getKeysAsString()

Description copied from interface: SignatureInterface

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

Specified by:

getKeysAsString in interface SignatureInterface

Returns:

the main key and the aliases.

getMainKey

public java.lang.String getMainKey()

Description copied from interface: SignatureInterface

Returns the main key of the signature.

Specified by:

getMainKey in interface SignatureInterface

Returns:

the main key.

getKeyArray

public java.lang.String[] getKeyArray()

Description copied from interface: SignatureInterface

Returns the main key and the aliases as an array.

Specified by:

getKeyArray in interface SignatureInterface

Returns:

the main key and the aliases.

getReturnValue

public ScriptType getReturnValue()

Returns the return type of the signature.

Returns:

the return type or null, if the return type is VOID.

getReturnValueAsString

public java.lang.String getReturnValueAsString()

Description copied from interface: SignatureInterface

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

Specified by:

getReturnValueAsString in interface SignatureInterface

Returns:

the string representation of the return type.

getStringRepresentation

public java.lang.String getStringRepresentation()

Description copied from interface: StringRepresentation

Returns a user-readable string representation of the object.

Specified by:

getStringRepresentation in interface StringRepresentation

Returns:

the object in it's string representation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object