Record Class CAI1TypeRecord

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.cb.CAI1TypeRecord

Record Components:

fieldName - The type declaration name.

fieldDescription - The type declaration description.

fieldFields - Whether or not the field is required to be present.

All Implemented Interfaces:

com.io7m.cedarbridge.runtime.api.CBSerializableType

public record CAI1TypeRecord(CAI1TypeRecordIdentifier fieldName, com.io7m.cedarbridge.runtime.api.CBString fieldDescription, com.io7m.cedarbridge.runtime.api.CBMap<CAI1TypeRecordFieldIdentifier,CAI1TypeField> fieldFields)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType

A type declaration.

Constructor Summary

Constructors

Constructor	Description
CAI1TypeRecord(CAI1TypeRecordIdentifier fieldName, com.io7m.cedarbridge.runtime.api.CBString fieldDescription, com.io7m.cedarbridge.runtime.api.CBMap<CAI1TypeRecordFieldIdentifier,CAI1TypeField> fieldFields)	Creates an instance of a CAI1TypeRecord record class.

Method Summary

Modifier and Type	Method	Description
static CAI1TypeRecord	deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)	Deserialize a value of type CAI1TypeRecord.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.io7m.cedarbridge.runtime.api.CBString	fieldDescription()	Returns the value of the fieldDescription record component.
com.io7m.cedarbridge.runtime.api.CBMap<CAI1TypeRecordFieldIdentifier,CAI1TypeField>	fieldFields()	Returns the value of the fieldFields record component.
CAI1TypeRecordIdentifier	fieldName()	Returns the value of the fieldName record component.
final int	hashCode()	Returns a hash code value for this object.
static void	serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, CAI1TypeRecord $x)	Serialize a value of type CAI1TypeRecord.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CAI1TypeRecord

public CAI1TypeRecord(CAI1TypeRecordIdentifier fieldName,
 com.io7m.cedarbridge.runtime.api.CBString fieldDescription,
 com.io7m.cedarbridge.runtime.api.CBMap<CAI1TypeRecordFieldIdentifier,CAI1TypeField> fieldFields)

Creates an instance of a CAI1TypeRecord record class.

Parameters:

fieldName - the value for the fieldName record component

fieldDescription - the value for the fieldDescription record component

fieldFields - the value for the fieldFields record component

Method Details

serialize

public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context,
 CAI1TypeRecord $x)
                      throws IOException

Serialize a value of type CAI1TypeRecord.

Parameters:

$context - The serialization context.

$x - The value to be serialized.

Throws:

IOException

deserialize

public static CAI1TypeRecord deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)
                                  throws IOException

Deserialize a value of type CAI1TypeRecord.

Parameters:

$context - The serialization context.

Returns:

A value of type CAI1TypeRecord.

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.

fieldName

public CAI1TypeRecordIdentifier fieldName()

Returns the value of the fieldName record component.

Returns:

the value of the fieldName 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

fieldFields

public com.io7m.cedarbridge.runtime.api.CBMap<CAI1TypeRecordFieldIdentifier,CAI1TypeField> fieldFields()

Returns the value of the fieldFields record component.

Returns:

the value of the fieldFields record component