Record Class CAI1ResponseLocationList

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.cb.CAI1ResponseLocationList
Record Components:
fieldRequestId - The ID of the request that yielded this response.
fieldLocations - The locations.
All Implemented Interfaces:
ProtocolCAIType, ProtocolCAIv1Type, com.io7m.cedarbridge.runtime.api.CBProtocolMessageType, com.io7m.cedarbridge.runtime.api.CBSerializableType
public record CAI1ResponseLocationList(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBUUID,CAI1LocationSummary> fieldLocations) extends Record implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolCAIv1Type
A response to CAI1CommandLocationList.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CAI1ResponseLocationList(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBUUID,CAI1LocationSummary> fieldLocations)
    Creates an instance of a CAI1ResponseLocationList record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CAI1ResponseLocationList
    deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)
    Deserialize a value of type CAI1ResponseLocationList.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBUUID,CAI1LocationSummary>
    fieldLocations()
    Returns the value of the fieldLocations record component.
    com.io7m.cedarbridge.runtime.api.CBUUID
    fieldRequestId()
    Returns the value of the fieldRequestId record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static void
    serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, CAI1ResponseLocationList $x)
    Serialize a value of type CAI1ResponseLocationList.
    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

    • CAI1ResponseLocationList

      public CAI1ResponseLocationList(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBUUID,CAI1LocationSummary> fieldLocations)
      Creates an instance of a CAI1ResponseLocationList record class.
      Parameters:
      fieldRequestId - the value for the fieldRequestId record component
      fieldLocations - the value for the fieldLocations record component

  • Method Details

    • serialize

      public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, CAI1ResponseLocationList $x) throws IOException
      Serialize a value of type CAI1ResponseLocationList.
      Parameters:
      $context - The serialization context.
      $x - The value to be serialized.
      Throws:
      IOException

    • deserialize

      public static CAI1ResponseLocationList deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) throws IOException
      Deserialize a value of type CAI1ResponseLocationList.
      Parameters:
      $context - The serialization context.
      Returns:
      A value of type CAI1ResponseLocationList.
      Throws:
      IOException

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

    • fieldRequestId

      public com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId()
      Returns the value of the fieldRequestId record component.
      Returns:
      the value of the fieldRequestId record component

    • fieldLocations

      public com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBUUID,CAI1LocationSummary> fieldLocations()
      Returns the value of the fieldLocations record component.
      Returns:
      the value of the fieldLocations record component