com.inductiveautomation.vision.api.client.components.model

Class ExtensionFunction

java.lang.Object

com.inductiveautomation.vision.api.client.components.model.ExtensionFunction

public class ExtensionFunction
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExtensionFunction(boolean enabled, java.lang.String script)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getScript()
static <T> T	invoke(ExtensibleComponent self, LoggerEx log, java.lang.String methodName, java.lang.Class<T> returnType, T defaultValue, java.lang.Object... args) Helper function to invoke an extension function.
static boolean	isDefined(ExtensibleComponent self, java.lang.String methodName) Tests whether or not the given extensible component has an enabled extension function for the given method name
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionFunction

public ExtensionFunction(boolean enabled,
                         java.lang.String script)

Method Detail

isEnabled

public boolean isEnabled()

getScript

public java.lang.String getScript()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isDefined

public static boolean isDefined(ExtensibleComponent self,
                                java.lang.String methodName)

Tests whether or not the given extensible component has an enabled extension function for the given method name

invoke

public static <T> T invoke(ExtensibleComponent self,
                           LoggerEx log,
                           java.lang.String methodName,
                           java.lang.Class<T> returnType,
                           T defaultValue,
                           java.lang.Object... args)

Helper function to invoke an extension function.

Parameters:

self - The component that is invoking

log - A logger to log any errors to. This function never throws an exception. Any problems are logged to this logger and the default will be returned.

methodName - The name of the extension function. Must match the associated ExtensionFunctionDescriptor's method name.

returnType - The type to coerce the script's return value into. For functions that don't need to return anything, use Void.class

defaultValue - The default return value. This will be returned if this extension function isn't implemented on self.

args - Arguments to pass to the function.

Returns:

whatever value the extensible function returned, or defaultValue if there was no extension function defined