Record Class CJ1TypePackageSummary

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.json.internal.CJ1TypePackageSummary
All Implemented Interfaces:
CJ1ValueType
@JsonClassDescription("A type package summary.") public record CJ1TypePackageSummary(CJ1TypePackageIdentifier identifier, String description) extends Record implements CJ1ValueType

  • Constructor Details

    • CJ1TypePackageSummary

      public CJ1TypePackageSummary(@JsonPropertyDescription("The package identifier.") CJ1TypePackageIdentifier identifier, @JsonPropertyDescription("The package description.") String description)
      Creates an instance of a CJ1TypePackageSummary record class.
      Parameters:
      identifier - the value for the identifier record component
      description - the value for the description 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.

    • identifier

      @JsonPropertyDescription("The package identifier.") public CJ1TypePackageIdentifier identifier()
      Returns the value of the identifier record component.
      Returns:
      the value of the identifier record component

    • description

      @JsonPropertyDescription("The package description.") public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component