Package com.ezylang.evalex.config

Interface FunctionDictionaryIfc

All Known Implementing Classes:

MapBasedFunctionDictionary

public interface FunctionDictionaryIfc

A function dictionary holds all the functions, that can be used in an expression.
The default implementation is the MapBasedFunctionDictionary.

Method Summary

Modifier and Type	Method	Description
void	addFunction(java.lang.String functionName, FunctionIfc function)	Allows to add a function to the dictionary.
default java.util.Set<java.lang.String>	getAvailableFunctionNames()	Get all function names in current configuration.
default java.util.Set<FunctionIfc>	getAvailableFunctions()	Get all functions in current configuration.
FunctionIfc	getFunction(java.lang.String functionName)	Get the function definition for a function name.
default boolean	hasFunction(java.lang.String functionName)	Check if the dictionary has a function with that name.

Method Detail

addFunction

void addFunction(java.lang.String functionName,
                 FunctionIfc function)

Allows to add a function to the dictionary. Implementation is optional, if you have a fixed set of functions, this method can throw an exception.

Parameters:

functionName - The function name.

function - The function implementation.

hasFunction

default boolean hasFunction(java.lang.String functionName)

Check if the dictionary has a function with that name.

Parameters:

functionName - The function name to look for.

Returns:

true if a function was found or false if not.

getFunction

FunctionIfc getFunction(java.lang.String functionName)

Get the function definition for a function name.

Parameters:

functionName - The name of the function.

Returns:

The function definition or null if no function was found.

getAvailableFunctionNames

default java.util.Set<java.lang.String> getAvailableFunctionNames()

Get all function names in current configuration.

Returns:

A set of all defined function names.

Throws:

java.lang.UnsupportedOperationException - when this operation is not supported by the implementation.

getAvailableFunctions

default java.util.Set<FunctionIfc> getAvailableFunctions()

Get all functions in current configuration.

Returns:

A set of all defined functions.

Throws:

java.lang.UnsupportedOperationException - when this operation is not supported by the implementation.