Record Class CJ1CommandItemSearchBegin

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.json.internal.CJ1CommandItemSearchBegin
All Implemented Interfaces:
CJ1CommandType, CJ1MessageType, CJ1ValueType
@JsonClassDescription("Start searching for items.") public record CJ1CommandItemSearchBegin(CJ1ItemSearchParameters parameters) extends Record implements CJ1CommandType

  • Constructor Details

    • CJ1CommandItemSearchBegin

      public CJ1CommandItemSearchBegin(@JsonPropertyDescription("The item search parameters.") CJ1ItemSearchParameters parameters)
      Creates an instance of a CJ1CommandItemSearchBegin record class.
      Parameters:
      parameters - the value for the parameters record component

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

    • parameters

      @JsonPropertyDescription("The item search parameters.") public CJ1ItemSearchParameters parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component