Package com.blackrook.rookscript.resolvers.hostfunction

Class CompoundHostFunctionResolver

java.lang.Object

com.blackrook.rookscript.resolvers.hostfunction.CompoundHostFunctionResolver

All Implemented Interfaces:

ScriptHostFunctionResolver

public class CompoundHostFunctionResolver
extends Object
implements ScriptHostFunctionResolver

A host function resolver that is a combination of multiple resolvers. Functions are resolved in the order that they are added to this resolver.

Author:

Matthew Tropiano

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
CompoundHostFunctionResolver()	Creates a new CompoundHostFunctionResolver.

Method Summary

Modifier and Type	Method	Description
CompoundHostFunctionResolver	addNamedResolver(String namespace, ScriptFunctionResolver resolver)	Adds a resolver in a namespace.
CompoundHostFunctionResolver	addResolver(ScriptFunctionResolver resolver)	Adds a global resolver.
CompoundHostFunctionResolver	clear()	Removes all resolvers (and all namespaced ones).
boolean	containsNamespacedFunction(String namespace, String name)	Attempts to find if this resolver has a function by its calling name and namespace.
ScriptFunctionType	getNamespacedFunction(String namespace, String name)	Attempts to resolve a pertinent function by its calling name.

Methods inherited from class java.lang.Object

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

Constructor Details

CompoundHostFunctionResolver

public CompoundHostFunctionResolver()

Creates a new CompoundHostFunctionResolver.

Method Details

addResolver

public CompoundHostFunctionResolver addResolver(ScriptFunctionResolver resolver)

Adds a global resolver.

Parameters:

resolver - the resolver to add.

Returns:

itself.

See Also:

• CompoundFunctionResolver.addResolver(ScriptFunctionResolver)

addNamedResolver

public CompoundHostFunctionResolver addNamedResolver(String namespace,
 ScriptFunctionResolver resolver)

Adds a resolver in a namespace. This will replace a namespace if it already had a resolver assigned.

Parameters:

namespace - the function namespace.

resolver - the resolver to add.

Returns:

itself.

clear

public CompoundHostFunctionResolver clear()

Removes all resolvers (and all namespaced ones).

Returns:

itself.

containsNamespacedFunction

public boolean containsNamespacedFunction(String namespace,
 String name)

Description copied from interface: ScriptHostFunctionResolver

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

A null namespace is valid, since it is a host call without declaring a namespace.

Names must be resolved case-insensitively!

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

Specified by:

containsNamespacedFunction in interface ScriptHostFunctionResolver

Parameters:

namespace - the function namespace (null is valid!).

name - the name to find.

Returns:

a corresponding function or null for no such function.

See Also:

• ScriptHostFunctionResolver.getNamespacedFunction(String, String)

getNamespacedFunction

public ScriptFunctionType getNamespacedFunction(String namespace,
 String name)

Description copied from interface: ScriptHostFunctionResolver

Attempts to resolve a pertinent function by its calling name.

A null namespace is valid, since it is a host call without declaring a namespace.

Names must be resolved case-insensitively!

If this returns a non-null for a function name, ScriptHostFunctionResolver.containsNamespacedFunction(String, 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:

getNamespacedFunction in interface ScriptHostFunctionResolver

Parameters:

namespace - the function namespace (null is valid!).

name - the name to resolve.

Returns:

a corresponding function or null for no such function.

See Also:

• ScriptHostFunctionResolver.containsNamespacedFunction(String, String)