DefaultFunctionFactory.StringFormatFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.StringFormatFunction

All Implemented Interfaces:: Function

Enclosing class:: DefaultFunctionFactory

public static class DefaultFunctionFactory.StringFormatFunction extends AbstractFunction

Field Summary

Fields

Modifier and Type

Field

Description

static final String

FUNCTION_NAME
Constructor Summary

Constructors

Constructor

Description

StringFormatFunction()
Method Summary

Modifier and Type

Method

Description

QualifiedValue

execute(Expression[] args)

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

String

getArgDocString()

Returns a string to be used in the auto-generated function documentation.

protected String

getFunctionDisplayName()

Class<?>

getType()

Returns the type that this function will return upon execution

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
executeArg, initArgs, log, validateNumArgs

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- FUNCTION_NAME
  
  public static final String FUNCTION_NAME
  See Also:
  
  Constant Field Values
Constructor Details
- StringFormatFunction
  
  public StringFormatFunction()
Method Details
- 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
- getType
  
  public Class<?> getType()
  
  Description copied from interface: Function
  
  Returns the type that this function will return upon execution
- getArgDocString
  
  public 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.
- getFunctionDisplayName
  
  protected String getFunctionDisplayName()
  
  Specified by:
  
  getFunctionDisplayName in class AbstractFunction