Package com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.NumberFormatFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.NumberFormatFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.NumberFormatFunction
extends AbstractFunction

Constructor Summary

Constructors

Constructor	Description
NumberFormatFunction()

Method Summary

Modifier and Type	Method	Description
void	connect(CommonContext context, InteractionListener updateListener)	This is to help the function listen for Locale changes broadcast by the EventBus.
Function	copy()	Returns this.
void	disconnect()	This is to help the function listen for Locale changes broadcast by the EventBus.
QualifiedValue	execute(Expression[] args)	Execute this function, and return the function's qualified value.
java.lang.String	getArgDocString()	Returns a string to be used in the auto-generated function documentation.
protected java.lang.String	getFunctionDisplayName()
java.lang.Class<?>	getType()	Returns the type that this function will return upon execution
void	onLocaleChange(LocaleChangeEvent ignored)
void	shutdown()	Empty implementation from BaseFunction.
void	startup()	Empty implementation from BaseFunction.
protected boolean	validateNumArgs(int num)

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

executeArg, initArgs, log

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

executeAll

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberFormatFunction

public NumberFormatFunction()

Method Detail

connect

public void connect(CommonContext context,
                    InteractionListener updateListener)

This is to help the function listen for Locale changes broadcast by the EventBus.

Specified by:

connect in interface Function

Overrides:

connect in class BaseFunction

startup

public void startup()

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

startup in interface Function

Overrides:

startup in class BaseFunction

shutdown

public void shutdown()

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

shutdown in interface Function

Overrides:

shutdown in class BaseFunction

disconnect

public void disconnect()

This is to help the function listen for Locale changes broadcast by the EventBus.

Specified by:

disconnect in interface Function

Overrides:

disconnect in class BaseFunction

onLocaleChange

public void onLocaleChange(LocaleChangeEvent ignored)

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

copy

public Function copy()

Description copied from class: BaseFunction

Returns this. Override to create a clone if you need a unique function object per Expression.

Specified by:

copy in interface Function

Overrides:

copy in class BaseFunction

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

Execute this function, and return the function's qualified value.

Throws:

ExpressionException

getArgDocString

public java.lang.String getArgDocString()

Description copied from interface: Function

Returns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.

getType

public java.lang.Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction