Record Class CAI1TypeScalarSearchParameters

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.cb.CAI1TypeScalarSearchParameters

Record Components:

fieldNameSearch - The type description search query.

fieldDescriptionSearch - The type description search query.

fieldLimit - The limit.

All Implemented Interfaces:

com.io7m.cedarbridge.runtime.api.CBSerializableType

public record CAI1TypeScalarSearchParameters(CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldNameSearch, CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldDescriptionSearch, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldLimit)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType

The scalar type search parameters.

Constructor Summary

Constructors

Constructor	Description
CAI1TypeScalarSearchParameters(CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldNameSearch, CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldDescriptionSearch, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldLimit)	Creates an instance of a CAI1TypeScalarSearchParameters record class.

Method Summary

Modifier and Type	Method	Description
static CAI1TypeScalarSearchParameters	deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)	Deserialize a value of type CAI1TypeScalarSearchParameters.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString>	fieldDescriptionSearch()	Returns the value of the fieldDescriptionSearch record component.
com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32	fieldLimit()	Returns the value of the fieldLimit record component.
CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString>	fieldNameSearch()	Returns the value of the fieldNameSearch record component.
final int	hashCode()	Returns a hash code value for this object.
static void	serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, CAI1TypeScalarSearchParameters $x)	Serialize a value of type CAI1TypeScalarSearchParameters.
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

CAI1TypeScalarSearchParameters

public CAI1TypeScalarSearchParameters(CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldNameSearch,
 CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldDescriptionSearch,
 com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldLimit)

Creates an instance of a CAI1TypeScalarSearchParameters record class.

Parameters:

fieldNameSearch - the value for the fieldNameSearch record component

fieldDescriptionSearch - the value for the fieldDescriptionSearch record component

fieldLimit - the value for the fieldLimit record component

Method Details

serialize

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

Serialize a value of type CAI1TypeScalarSearchParameters.

Parameters:

$context - The serialization context.

$x - The value to be serialized.

Throws:

IOException

deserialize

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

Deserialize a value of type CAI1TypeScalarSearchParameters.

Parameters:

$context - The serialization context.

Returns:

A value of type CAI1TypeScalarSearchParameters.

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.

fieldNameSearch

public CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldNameSearch()

Returns the value of the fieldNameSearch record component.

Returns:

the value of the fieldNameSearch record component

fieldDescriptionSearch

public CAI1ComparisonFuzzy<com.io7m.cedarbridge.runtime.api.CBString> fieldDescriptionSearch()

Returns the value of the fieldDescriptionSearch record component.

Returns:

the value of the fieldDescriptionSearch record component

fieldLimit

public com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldLimit()

Returns the value of the fieldLimit record component.

Returns:

the value of the fieldLimit record component