Package com.inductiveautomation.ignition.common.expressions

Interface ExpressionFunctionManager

All Superinterfaces:

FunctionFactory

All Known Implementing Classes:

BasicFunctionFactory, ClientFunctionFactory.DynamicDispatchCreatorManager

public interface ExpressionFunctionManager
extends FunctionFactory

This interface is used in conjunction with the FunctionFactory, but provides the functions to add new expressions.

Method Summary

Modifier and Type	Method	Description
void	addFunction(java.lang.String name, java.lang.String category, Function f)	Adds the given function to the expression system.
void	addFunction(java.lang.String name, java.lang.String category, Function f, boolean visible)	Adds the given function, optionally making it invisible to the various configuration helpers.
boolean	isDefined(java.lang.String functionName)	Returns whether the specified function has already been defined.

Methods inherited from interface com.inductiveautomation.ignition.common.expressions.FunctionFactory

getCategories, getFunction, getFunctionNames, getFunctionsInCategory

Method Detail

addFunction

void addFunction(java.lang.String name,
                 java.lang.String category,
                 Function f)
          throws java.lang.IllegalArgumentException

Adds the given function to the expression system.

Throws:

java.lang.IllegalArgumentException - if the provided function name already exists.

addFunction

void addFunction(java.lang.String name,
                 java.lang.String category,
                 Function f,
                 boolean visible)
          throws java.lang.IllegalArgumentException

Adds the given function, optionally making it invisible to the various configuration helpers. This is useful for supporting backwards compatibility of "legacy" expression functions.

Throws:

java.lang.IllegalArgumentException

isDefined

boolean isDefined(java.lang.String functionName)

Returns whether the specified function has already been defined.