Package com.inductiveautomation.ignition.common.script

Record Class ScriptConfig.TimerScript

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.common.script.ScriptConfig.TimerScript

Enclosing class:

ScriptConfig

public static record ScriptConfig.TimerScript(TimerKey timerKey, String script)
extends Record

Configuration resource for timer scripts.

This record class is designed for reuse by other modules, allowing them to define their own resource types and descriptors while utilizing this class.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	DESCRIPTOR
static final String	METHOD_NAME
static final String	RESOURCE_KEY
static final ResourceType	RESOURCE_TYPE

Constructor Summary

Constructors

Constructor	Description
TimerScript(TimerKey timerKey, String script)	Creates an instance of a TimerScript record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static ScriptConfig.TimerScript	ofResource(Resource resource)
String	script()	Returns the value of the script record component.
static Consumer<ResourceBuilder>	serialize(TimerKey timerKey, String script, com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor descriptor)
TimerKey	timerKey()	Returns the value of the timerKey record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

METHOD_NAME

public static final String METHOD_NAME

See Also:

• Constant Field Values

RESOURCE_KEY

public static final String RESOURCE_KEY

See Also:

• Constant Field Values

DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor DESCRIPTOR

Constructor Details

TimerScript

public TimerScript(TimerKey timerKey,
 String script)

Creates an instance of a TimerScript record class.

Parameters:

timerKey - the value for the timerKey record component

script - the value for the script record component

Method Details

ofResource

public static ScriptConfig.TimerScript ofResource(Resource resource)

serialize

public static Consumer<ResourceBuilder> serialize(TimerKey timerKey,
 String script,
 com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor descriptor)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

timerKey

public TimerKey timerKey()

Returns the value of the timerKey record component.

Returns:

the value of the timerKey record component

script

public String script()

Returns the value of the script record component.

Returns:

the value of the script record component