Package com.blackrook.rookscript.lang

Class ScriptFunctionUsage

java.lang.Object

com.blackrook.rookscript.lang.ScriptFunctionUsage

All Implemented Interfaces:

ScriptFunctionType.Usage

public final class ScriptFunctionUsage
extends Object
implements ScriptFunctionType.Usage

Function usage builder.

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType.Usage

ScriptFunctionType.Usage.ParameterUsage, ScriptFunctionType.Usage.TypeUsage

Method Summary

Modifier and Type	Method	Description
static ScriptFunctionUsage	create()
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.
ScriptFunctionUsage	instructions(String instructions)	Sets the instructions.
ScriptFunctionUsage	parameter(String name, ScriptFunctionType.Usage.TypeUsage... usages)	Adds a parameter's usage.
ScriptFunctionUsage	returns(ScriptFunctionType.Usage.TypeUsage... typeUsages)	Adds return types.
static ScriptFunctionType.Usage.TypeUsage	type(ScriptValue.Type type, String description)	Creates a single type usage.
static ScriptFunctionType.Usage.TypeUsage	type(ScriptValue.Type type, String objectRefType, String description)	Creates a single type usage.
static ScriptFunctionType.Usage.TypeUsage	type(String description)	Creates a single type usage.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ScriptFunctionUsage create()

Returns:

a new usage description.

type

public static ScriptFunctionType.Usage.TypeUsage type(String description)

Creates a single type usage.

Parameters:

description - its description.

Returns:

a new type usage.

type

public static ScriptFunctionType.Usage.TypeUsage type(ScriptValue.Type type,
 String description)

Creates a single type usage.

Parameters:

type - the script value type.

description - its description.

Returns:

a new type usage.

type

public static ScriptFunctionType.Usage.TypeUsage type(ScriptValue.Type type,
 String objectRefType,
 String description)

Creates a single type usage.

Parameters:

type - the script value type.

objectRefType - if type is ScriptValue.Type.OBJECTREF, then this is the expected Object type.

description - its description.

Returns:

a new type usage.

instructions

public ScriptFunctionUsage instructions(String instructions)

Sets the instructions.

Parameters:

instructions - the new instructions.

Returns:

itself.

parameter

public ScriptFunctionUsage parameter(String name,
 ScriptFunctionType.Usage.TypeUsage... usages)

Adds a parameter's usage.

Parameters:

name - the parameter name.

usages - each accepted type and its description.

Returns:

itself.

returns

public ScriptFunctionUsage returns(ScriptFunctionType.Usage.TypeUsage... typeUsages)

Adds return types.

Parameters:

typeUsages - each returned type and its description.

Returns:

itself.

getInstructions

public String getInstructions()

Description copied from interface: ScriptFunctionType.Usage

Gets the function usage instructions.

Specified by:

getInstructions in interface ScriptFunctionType.Usage

Returns:

the function usage instructions. Never returns null.

getParameterInstructions

public List<ScriptFunctionType.Usage.ParameterUsage> getParameterInstructions()

Description copied from interface: ScriptFunctionType.Usage

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.

Specified by:

getParameterInstructions in interface ScriptFunctionType.Usage

Returns:

the usage instructions per function parameter. Never returns null.

See Also:

• ScriptFunctionType.getParameterCount()

getReturnTypes

public List<ScriptFunctionType.Usage.TypeUsage> getReturnTypes()

Description copied from interface: ScriptFunctionType.Usage

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

Specified by:

getReturnTypes in interface ScriptFunctionType.Usage

Returns:

the list of return types. Never returns null.