Package com.inductiveautomation.ignition.gateway.services.tts

Record Class TTSEngineDescriptor

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.services.tts.TTSEngineDescriptor

public record TTSEngineDescriptor(String id, LocalizedString displayName, TTSEngine engine)
extends Record

Constructor Summary

Constructors

Constructor	Description
TTSEngineDescriptor(String id, LocalizedString displayName, TTSEngine engine)	Creates an instance of a TTSEngineDescriptor record class.

Method Summary

Modifier and Type	Method	Description
LocalizedString	displayName()	Returns the value of the displayName record component.
TTSEngine	engine()	Returns the value of the engine 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.
String	id()	Returns the value of the id 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

Constructor Details

TTSEngineDescriptor

public TTSEngineDescriptor(String id,
 LocalizedString displayName,
 TTSEngine engine)

Creates an instance of a TTSEngineDescriptor record class.

Parameters:

id - the value for the id record component

displayName - the value for the displayName record component

engine - the value for the engine record component

Method Details

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

displayName

public LocalizedString displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

engine

public TTSEngine engine()

Returns the value of the engine record component.

Returns:

the value of the engine record component