ScriptFunctionType.Usage

All Known Implementing Classes:: ScriptFunctionUsage

Enclosing interface:: ScriptFunctionType

public static interface ScriptFunctionType.Usage

Function usage info.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

ScriptFunctionType.Usage.ParameterUsage

A single parameter's usage instructions.

static interface

ScriptFunctionType.Usage.TypeUsage

Per-relevant-type usage.
Method Summary

Modifier and Type

Method

Description

String

getInstructions()

Gets the function usage instructions.

List<ScriptFunctionType.Usage.ParameterUsage>

getParameterInstructions()

Gets the usage instructions per function parameter, in the order of the functions parameters.

List<ScriptFunctionType.Usage.TypeUsage>

getReturnTypes()

Gets a list of accepted, expected return types for this function.

Method Details
- getInstructions
  
  String getInstructions()
  
  Gets the function usage instructions.
  
  Returns:
  
  the function usage instructions. Never returns null.
- getParameterInstructions
  
  List<ScriptFunctionType.Usage.ParameterUsage> getParameterInstructions()
  
  Gets the usage instructions per function parameter, in the order of the functions parameters. Can be null for no instructions. Must match function's parameter count.
  Returns:
  
  the usage instructions per function parameter. Never returns null.
  
  See Also:
  
  ScriptFunctionType.getParameterCount()
- getReturnTypes
  
  List<ScriptFunctionType.Usage.TypeUsage> getReturnTypes()
  
  Gets a list of accepted, expected return types for this function.
  
  Returns:
  
  the list of return types. Never returns null.