Record Class ARI1PortDescription

java.lang.Object
java.lang.Record
com.io7m.aradine.instrument.spi1.ARI1PortDescription
Record Components:
kind - The port kind
direction - The port direction
number - The port number
label - The port label
semantics - The port semantics
documentation - The documentation
All Implemented Interfaces:
ARI1DocumentedType
public record ARI1PortDescription(ARI1PortKind kind, ARI1PortDirection direction, ARI1PortNumber number, String label, Set<String> semantics, Optional<ARI1Documentation> documentation) extends Record implements ARI1DocumentedType
A description of a port used to supply data to, or extract data from, an instrument.

  • Constructor Details

    • ARI1PortDescription

      public ARI1PortDescription(ARI1PortKind kind, ARI1PortDirection direction, ARI1PortNumber number, String label, Set<String> semantics, Optional<ARI1Documentation> documentation)
      A description of a port used to supply data to, or extract data from, an instrument.
      Parameters:
      kind - The port kind
      direction - The port direction
      number - The port number
      label - The port label
      semantics - The port semantics
      documentation - The 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.

    • kind

      public ARI1PortKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • direction

      public ARI1PortDirection direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component

    • number

      public ARI1PortNumber number()
      Returns the value of the number record component.
      Returns:
      the value of the number record component

    • label

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

    • semantics

      public Set<String> semantics()
      Returns the value of the semantics record component.
      Returns:
      the value of the semantics record component

    • documentation

      public Optional<ARI1Documentation> documentation()
      Returns the value of the documentation record component.
      Specified by:
      documentation in interface ARI1DocumentedType
      Returns:
      the value of the documentation record component