Package com.io7m.cardant.protocol.inventory.cb

Record Class CAI1ResponseItemSearch

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.cb.CAI1ResponseItemSearch
Record Components:
fieldRequestId - The ID of the request that yielded this response.
fieldResults - The results.
All Implemented Interfaces:
ProtocolCAIType, ProtocolCAIv1Type, com.io7m.cedarbridge.runtime.api.CBProtocolMessageType, com.io7m.cedarbridge.runtime.api.CBSerializableType
public record CAI1ResponseItemSearch(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, CAI1Page<CAI1ItemSummary> fieldResults) extends Record implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolCAIv1Type
A response to CAI1CommandItemSearch.

  • Constructor Details

    • CAI1ResponseItemSearch

      public CAI1ResponseItemSearch(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, CAI1Page<CAI1ItemSummary> fieldResults)
      Creates an instance of a CAI1ResponseItemSearch record class.
      Parameters:
      fieldRequestId - the value for the fieldRequestId record component
      fieldResults - the value for the fieldResults record component

  • Method Details

    • serialize

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

    • deserialize

      public static CAI1ResponseItemSearch deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) throws IOException
      Deserialize a value of type CAI1ResponseItemSearch.
      Parameters:
      $context - The serialization context.
      Returns:
      A value of type CAI1ResponseItemSearch.
      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

    • fieldResults

      public CAI1Page<CAI1ItemSummary> fieldResults()
      Returns the value of the fieldResults record component.
      Returns:
      the value of the fieldResults record component