ParameterTuple

java.lang.Object
- scriptinterface.ParameterTuple

All Implemented Interfaces:

StringRepresentation
```
public class ParameterTuple
extends java.lang.Object
implements StringRepresentation
```
Contains an ordered list of parameters each consisting of key and type

Constructor Summary

Constructors
Constructor and Description

ParameterTuple()

Constructors
Constructor and Description
`ParameterTuple()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExecutionError`	`checkCall(ExecutionReturn[] arguments)` Checks if the given evaluated arguments array contains arguments that fit to this parameter tuple.
`void`	`create(int size, ScriptSystemInterface<?,?> scriptSystem, int minimumArguments, boolean unlimitedArguments)` Initializes an empty parameter tuple.
`ExecutionError`	`createFromString(java.lang.String declarations, ScriptSystemInterface<?,?> scriptSystem)` Parses the given string to create the parameter tuple.
`ExecutionResult<?>`	`getDefaultArg(int paramIndex)` Returns the evaluated default argument of the parameter at the given index.
`ExecutionResult<?>[]`	`getDefaultArgs()` Returns the evaluated default arguments as an array, whereas the first entry is the first default argument, not necessarily the first parameter.
`int`	`getMinArgumentCount()` Returns the minimum number of arguments a caller has to pass.
`int`	`getParamCount(boolean includeUnlimited)` Returns the number of parameters.
`java.lang.String[]`	`getParameterNames()` Returns the names of the parameters as an array.
`ScriptType[]`	`getParameterTypes()` Returns the types of the parameters as an array.
`java.lang.String`	`getParamName(int paramIndex)` Returns the name of the parameter at the given index.
`ScriptType`	`getParamType(int paramIndex)` Returns the type of the parameter at the given index.
`java.lang.String`	`getStringRepresentation()` Returns a user-readable string representation of the object.
`boolean`	`isEmpty()`
`boolean`	`isUnlimitedArguments()` Tells whether or not a caller can pass arguments at any number.
`java.lang.String`	`paramToString(int paramIndex, java.lang.String whiteSpace)` Returns a string representation of the parameter at the given index.
`void`	`setDefaultValue(int paramIndex, ExecutionResult<?> value)` Sets the default value of the parameter at the given index.
`void`	`setMinimumArgumentCount(int minimumArguments)` Sets the minimum number of arguments a caller has to pass.
`void`	`setParameter(int paramIndex, java.lang.String name, ScriptType type)` Sets the name and type of the parameter at the given index.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ParameterTuple
```
public ParameterTuple()
```
- Method Detail
  - create
```
public void create(int size,
                   ScriptSystemInterface<?,?> scriptSystem,
                   int minimumArguments,
                   boolean unlimitedArguments)
```
    Initializes an empty parameter tuple.
    
    Parameters:
    
    size - the number of parameters.
    
    scriptSystem - a script system to evaluate default arguments.
    
    minimumArguments - the minimum argument count a caller has to pass.
    
    unlimitedArguments - if true, then the caller can give arguments of the last parameter type at any number.
  - createFromString
```
public ExecutionError createFromString(java.lang.String declarations,
                                       ScriptSystemInterface<?,?> scriptSystem)
                                throws ParameterParseException
```
    Parses the given string to create the parameter tuple.
    
    Parameters:
    
    declarations - the parameters, types and default values given as string. The syntax is equal to the syntax of the parameters of signatures.
    
    scriptSystem - a script system to evaluate the default arguments.
    
    Returns:
    
    null, if the initialization was successful, an execution error otherwise.
    
    Throws:
    
    ParameterParseException - if an parameter is invalid.
  - isUnlimitedArguments
```
public final boolean isUnlimitedArguments()
```
    Tells whether or not a caller can pass arguments at any number.
    
    Returns:
    
    true if and only if unlimited arguments can be passed.
  - getParameterTypes
```
public ScriptType[] getParameterTypes()
```
    Returns the types of the parameters as an array.
    
    Returns:
    
    a reference to the parameter type array.
  - getParameterNames
```
public java.lang.String[] getParameterNames()
```
    Returns the names of the parameters as an array.
    
    Returns:
    
    a reference to the parameter name array.
  - getDefaultArgs
```
public ExecutionResult<?>[] getDefaultArgs()
```
    Returns the evaluated default arguments as an array, whereas the first entry is the first default argument, not necessarily the first parameter.
    
    Returns:
    
    a reference to the default arguments array.
  - setParameter
```
public void setParameter(int paramIndex,
                         java.lang.String name,
                         ScriptType type)
```
    Sets the name and type of the parameter at the given index.
    
    Parameters:
    
    paramIndex - the index of the parameter to set (starting at 0).
    
    name - the new name of the parameter.
    
    type - the new type of the parameter.
  - setDefaultValue
```
public void setDefaultValue(int paramIndex,
                            ExecutionResult<?> value)
```
    Sets the default value of the parameter at the given index. Note that the given id must be consistent to the initialization, that is, the given id must not be smaller than the minimum argument count.
    
    Parameters:
    
    paramIndex - the index of the parameter to set the default value (starting at 0 for the first parameter).
    
    value - the default value.
  - getParamCount
```
public final int getParamCount(boolean includeUnlimited)
```
    Returns the number of parameters.
    
    Parameters:
    
    includeUnlimited - if true and unlimited arguments can be passed (which is set in the initialization) then Integer.MAX_VALUE is returned as an indicator for infinity. If false, then the number of name-type-pairs is given.
    
    Returns:
    
    the number of parameters.
  - getParamName
```
public java.lang.String getParamName(int paramIndex)
```
    Returns the name of the parameter at the given index.
    
    Parameters:
    
    paramIndex - the index of the parameter beginning at 0.
    
    Returns:
    
    the name of the parameter.
  - getParamType
```
public ScriptType getParamType(int paramIndex)
```
    Returns the type of the parameter at the given index.
    
    Parameters:
    
    paramIndex - the index of the parameter beginning at 0.
    
    Returns:
    
    the type of the parameter.
  - getDefaultArg
```
public ExecutionResult<?> getDefaultArg(int paramIndex)
```
    Returns the evaluated default argument of the parameter at the given index. Note that the given id must be consistent to the initialization, that is, the given id must not be smaller than the minimum argument count.
    
    Parameters:
    
    paramIndex - the index of the parameter beginning at 0.
    
    Returns:
    
    the default argument value of the parameter.
  - setMinimumArgumentCount
```
public void setMinimumArgumentCount(int minimumArguments)
```
    Sets the minimum number of arguments a caller has to pass. This (re)initializes the default arguments.
    
    Parameters:
    
    minimumArguments - the minimum number of arguments the caller has to pass.
  - getMinArgumentCount
```
public int getMinArgumentCount()
```
    Returns the minimum number of arguments a caller has to pass.
    
    Returns:
    
    the minimum argument count.
  - paramToString
```
public java.lang.String paramToString(int paramIndex,
                                      java.lang.String whiteSpace)
```
    Returns a string representation of the parameter at the given index.
    
    Parameters:
    
    paramIndex - the index of the parameter beginning at 0.
    
    whiteSpace - the white space to insert for the string representation. Can be "" as well for no white space.
    
    Returns:
    
    a string representation of the parameter.
  - checkCall
```
public ExecutionError checkCall(ExecutionReturn[] arguments)
```
    Checks if the given evaluated arguments array contains arguments that fit to this parameter tuple. At the same time, type casts are done on particular arguments of the array if it is necessary and possible. If everything succeeds, then argument i is of type parameter i in the end.
    
    Parameters:
    
    arguments - the arguments to check and to cast, if necessary.
    
    Returns:
    
    null, if the arguments are valid in number and types. Otherwise, an execution error.
  - 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
  - isEmpty
```
public boolean isEmpty()
```

Class ParameterTuple

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParameterTuple

Method Detail

create

createFromString

isUnlimitedArguments

getParameterTypes

getParameterNames

getDefaultArgs

setParameter

setDefaultValue

getParamCount

getParamName

getParamType

getDefaultArg

setMinimumArgumentCount

getMinArgumentCount

paramToString

checkCall

getStringRepresentation

toString

isEmpty