Record Class CAI1TypePackageSummary

java.lang.Object
java.lang.Record
com.io7m.cardant.protocol.inventory.cb.CAI1TypePackageSummary
Record Components:
fieldIdentifier - The package identifier.
fieldDescription - The package description.
All Implemented Interfaces:
com.io7m.cedarbridge.runtime.api.CBSerializableType

public record CAI1TypePackageSummary(CAI1TypePackageIdentifier fieldIdentifier, com.io7m.cedarbridge.runtime.api.CBString fieldDescription) extends Record implements com.io7m.cedarbridge.runtime.api.CBSerializableType
The type package summary.
  • Constructor Details

    • CAI1TypePackageSummary

      public CAI1TypePackageSummary(CAI1TypePackageIdentifier fieldIdentifier, com.io7m.cedarbridge.runtime.api.CBString fieldDescription)
      Creates an instance of a CAI1TypePackageSummary record class.
      Parameters:
      fieldIdentifier - the value for the fieldIdentifier record component
      fieldDescription - the value for the fieldDescription record component
  • Method Details

    • serialize

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

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

      public CAI1TypePackageIdentifier fieldIdentifier()
      Returns the value of the fieldIdentifier record component.
      Returns:
      the value of the fieldIdentifier record component
    • fieldDescription

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