DefaultFunctionFactory.CaseFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SwitchFunction

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.CaseFunction

All Implemented Interfaces:: Function

Enclosing class:: DefaultFunctionFactory

public static class DefaultFunctionFactory.CaseFunction extends DefaultFunctionFactory.SwitchFunction

Constructor Summary

Constructors

Constructor

Description

CaseFunction()
Method Summary

Modifier and Type

Method

Description

Function

copy()

Returns this.

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()

Methods inherited from class com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SwitchFunction
getCaseType, getType, setCaseType, setType, validateNumArgs

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
connect, disconnect, executeAll, shutdown, startup

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

Constructor Details
- CaseFunction
  
  public CaseFunction()
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.
  
  Specified by:
  
  execute in interface Function
  
  Overrides:
  
  execute in class DefaultFunctionFactory.SwitchFunction
  
  Throws:
  
  ExpressionException
- getFunctionDisplayName
  
  protected String getFunctionDisplayName()
  
  Overrides:
  
  getFunctionDisplayName in class DefaultFunctionFactory.SwitchFunction
- 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.
  
  Specified by:
  
  getArgDocString in interface Function
  
  Overrides:
  
  getArgDocString in class DefaultFunctionFactory.SwitchFunction
- 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 DefaultFunctionFactory.SwitchFunction