Class EnumFunctionResolver

java.lang.Object

com.blackrook.rookscript.resolvers.hostfunction.EnumFunctionResolver

All Implemented Interfaces:

ScriptFunctionResolver

public class EnumFunctionResolver
extends Object
implements ScriptFunctionResolver

A special kind of host function resolver that wraps an Enum of ScriptFunctionType.

Author:

Matthew Tropiano

Field Summary

Fields inherited from interface com.blackrook.rookscript.resolvers.ScriptFunctionResolver

EMPTY

Constructor Summary

Constructors

Constructor	Description
EnumFunctionResolver(Enum<? extends ScriptFunctionType>... en)	Creates a new resolver using a list of enum values.

Method Summary

Modifier and Type	Method	Description
boolean	containsFunction(String name)	Attempts to find if this resolver has a function by its calling name.
ScriptFunctionType	getFunction(String name)	Attempts to resolve a pertinent function by its calling name.
ScriptFunctionType[]	getFunctions()	Gets the full list of all script functions.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumFunctionResolver

@SafeVarargs
public EnumFunctionResolver(Enum<? extends ScriptFunctionType>... en)

Creates a new resolver using a list of enum values.

Parameters:

en - the list of enum values (usually Enum.values()).

Method Details

getFunction

public ScriptFunctionType getFunction(String name)

Description copied from interface: ScriptFunctionResolver

Attempts to resolve a pertinent function by its calling name.

Names must be resolved case-insensitively!

If this returns a non-null for a function name, ScriptFunctionResolver.containsFunction(String) must NOT return false if called with that name!

The same function must be returned if this is called again with the same name!

Specified by:

getFunction in interface ScriptFunctionResolver

Parameters:

name - the name to resolve.

Returns:

a corresponding function or null for no such function.

See Also:

• ScriptFunctionResolver.containsFunction(String)

containsFunction

public boolean containsFunction(String name)

Description copied from interface: ScriptFunctionResolver

Attempts to find if this resolver has a function by its calling name.

Names must be resolved case-insensitively!

If this returns true for a function name, ScriptFunctionResolver.getFunction(String) must NOT return null if called with that name!

Specified by:

containsFunction in interface ScriptFunctionResolver

Parameters:

name - the name to find.

Returns:

a corresponding function or null for no such function.

getFunctions

public ScriptFunctionType[] getFunctions()

Description copied from interface: ScriptFunctionResolver

Gets the full list of all script functions. Depending on the implementation, this may be an expensive lookup.

Specified by:

getFunctions in interface ScriptFunctionResolver

Returns:

a list of all functions.