Record Class ARI1JParameterDescriptionSampleMap

java.lang.Object
java.lang.Record
com.io7m.aradine.instrument.spi1.json_data.internal.ARI1JParameterDescriptionSampleMap
Record Components:
number - The parameter ID
label - The parameter label
documentation - The parameter documentation
All Implemented Interfaces:
ARI1JElementType, ARI1JParameterDescriptionType
public record ARI1JParameterDescriptionSampleMap(ARI1JParameterNumber number, String label, Optional<ARI1JDocumentation> documentation) extends Record implements ARI1JParameterDescriptionType, ARI1JElementType

The type of sample map parameters.

  • Constructor Details

    • ARI1JParameterDescriptionSampleMap

      public ARI1JParameterDescriptionSampleMap(ARI1JParameterNumber number, String label, Optional<ARI1JDocumentation> documentation)

      The type of sample map parameters.

      Parameters:
      number - The parameter ID
      label - The parameter label
      documentation - The parameter documentation

  • 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.

    • number

      public ARI1JParameterNumber number()
      Returns the value of the number record component.
      Specified by:
      number in interface ARI1JParameterDescriptionType
      Returns:
      the value of the number record component

    • label

      public String label()
      Returns the value of the label record component.
      Specified by:
      label in interface ARI1JParameterDescriptionType
      Returns:
      the value of the label record component

    • documentation

      public Optional<ARI1JDocumentation> documentation()
      Returns the value of the documentation record component.
      Returns:
      the value of the documentation record component