com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.DateFormatFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.DateFormatFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.DateFormatFunction
extends AbstractFunction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FUNC_NAME
static java.util.Map<java.lang.String,java.lang.String>	specialFormats

Constructor Summary

Constructors

Constructor and Description
DateFormatFunction()

Method Summary

Modifier and Type	Method and Description
void	connect(BaseContext 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 of Object that this function will generate with execute
void	onLocaleChange(LocaleChangeEvent event)
void	shutdown() Empty implementation from BaseFunction.
void	startup() Empty implementation from BaseFunction.
protected boolean	validateArgType(int argNum, java.lang.Class<?> type)
protected boolean	validateNumArgs(int num)

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

initArgs

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

Field Detail

FUNC_NAME

public static final java.lang.String FUNC_NAME

See Also:

Constant Field Values

specialFormats

public static final java.util.Map<java.lang.String,java.lang.String> specialFormats

Constructor Detail

DateFormatFunction

public DateFormatFunction()

Method Detail

connect

public void connect(BaseContext 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 event)

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

Returns:

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

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

Returns:

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.

Returns:

getType

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

Description copied from interface: Function

Returns the type of Object that this function will generate with execute

Returns:

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

validateArgType

protected boolean validateArgType(int argNum,
                                  java.lang.Class<?> type)

Overrides:

validateArgType in class AbstractFunction