Package com.inductiveautomation.eventstream.encoder

Record Class EventStreamEncoder.Descriptor

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.encoder.EventStreamEncoder.Descriptor
Record Components:
type - Unique id of EventStreamEncoder. Will be unique per EventStreamEncoder.
label - Human-readable name of Encoder
properties - Optional properties that change the behavior of EventStreamEncoder. Map consists of a key and default value.
Enclosing interface:
EventStreamEncoder
public static record EventStreamEncoder.Descriptor(String type, String label, com.inductiveautomation.ignition.common.gson.JsonObject properties) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Descriptor(String type, String label, com.inductiveautomation.ignition.common.gson.JsonObject properties)
    Creates an instance of a Descriptor 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.
    String
    label()
    Returns the value of the label record component.
    com.inductiveautomation.ignition.common.gson.JsonObject
    properties()
    Returns the value of the properties record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Descriptor

      public Descriptor(String type, String label, com.inductiveautomation.ignition.common.gson.JsonObject properties)
      Creates an instance of a Descriptor record class.
      Parameters:
      type - the value for the type record component
      label - the value for the label record component
      properties - the value for the properties 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.

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • properties

      public com.inductiveautomation.ignition.common.gson.JsonObject properties()
      Returns the value of the properties record component.
      Returns:
      the value of the properties record component