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

Record Class CAI1CommandFileSearchBegin

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.cb.CAI1CommandFileSearchBegin
Record Components:
fieldParameters - The search parameters.
All Implemented Interfaces:
ProtocolCAIType, ProtocolCAIv1Type, com.io7m.cedarbridge.runtime.api.CBProtocolMessageType, com.io7m.cedarbridge.runtime.api.CBSerializableType
public record CAI1CommandFileSearchBegin(CAI1FileSearchParameters fieldParameters) extends Record implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolCAIv1Type
Start searching for items.

  • Constructor Details

    • CAI1CommandFileSearchBegin

      public CAI1CommandFileSearchBegin(CAI1FileSearchParameters fieldParameters)
      Creates an instance of a CAI1CommandFileSearchBegin record class.
      Parameters:
      fieldParameters - the value for the fieldParameters record component

  • Method Details

    • serialize

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

    • deserialize

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

    • fieldParameters

      public CAI1FileSearchParameters fieldParameters()
      Returns the value of the fieldParameters record component.
      Returns:
      the value of the fieldParameters record component