Package com.inductiveautomation.ignition.common.script

Record Class ScriptConfig.StartupScript

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.common.script.ScriptConfig.StartupScript

Enclosing class:

ScriptConfig

public static record ScriptConfig.StartupScript(String script, boolean enabled)
extends Record

Configuration resource for startup scripts.

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
StartupScript(String script, boolean enabled)	Creates an instance of a StartupScript record class.

Method Summary

Modifier and Type	Method	Description
boolean	enabled()	Returns the value of the enabled record component.
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.StartupScript	ofResource(Resource resource)
String	script()	Returns the value of the script record component.
static Consumer<ResourceBuilder>	serialize(String script, boolean enabled, com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor descriptor)	Serializes the startup script data, using the given descriptor to populate the "preamble" text used on disk.
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

StartupScript

public StartupScript(String script,
 boolean enabled)

Creates an instance of a StartupScript record class.

Parameters:

script - the value for the script record component

enabled - the value for the enabled record component

Method Details

ofResource

public static ScriptConfig.StartupScript ofResource(Resource resource)

serialize

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

Serializes the startup script data, using the given descriptor to populate the "preamble" text used on disk.

The same descriptor is used for both Gateway and Client startup events since they share the same method definition.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

script

public String script()

Returns the value of the script record component.

Returns:

the value of the script record component

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component