Record Class CAI1StockSearchParameters

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.cb.CAI1StockSearchParameters

Record Components:

fieldLocationMatch - The location match.

fieldItemMatch - The item match.

fieldIncludeOccurrences - The kinds of stock occurrences to include.

fieldPageSize - The page size.

All Implemented Interfaces:

com.io7m.cedarbridge.runtime.api.CBSerializableType

public record CAI1StockSearchParameters(CAI1LocationMatch fieldLocationMatch, CAI1ComparisonExact<com.io7m.cedarbridge.runtime.api.CBUUID> fieldItemMatch, com.io7m.cedarbridge.runtime.api.CBList<CAI1StockOccurrenceKind> fieldIncludeOccurrences, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldPageSize)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType

The stock search parameters.

Constructor Summary

Constructors

Constructor	Description
CAI1StockSearchParameters(CAI1LocationMatch fieldLocationMatch, CAI1ComparisonExact<com.io7m.cedarbridge.runtime.api.CBUUID> fieldItemMatch, com.io7m.cedarbridge.runtime.api.CBList<CAI1StockOccurrenceKind> fieldIncludeOccurrences, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldPageSize)	Creates an instance of a CAI1StockSearchParameters record class.

Method Summary

Modifier and Type	Method	Description
static CAI1StockSearchParameters	deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)	Deserialize a value of type CAI1StockSearchParameters.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.io7m.cedarbridge.runtime.api.CBList<CAI1StockOccurrenceKind>	fieldIncludeOccurrences()	Returns the value of the fieldIncludeOccurrences record component.
CAI1ComparisonExact<com.io7m.cedarbridge.runtime.api.CBUUID>	fieldItemMatch()	Returns the value of the fieldItemMatch record component.
CAI1LocationMatch	fieldLocationMatch()	Returns the value of the fieldLocationMatch record component.
com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32	fieldPageSize()	Returns the value of the fieldPageSize record component.
final int	hashCode()	Returns a hash code value for this object.
static void	serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, CAI1StockSearchParameters $x)	Serialize a value of type CAI1StockSearchParameters.
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

CAI1StockSearchParameters

public CAI1StockSearchParameters(CAI1LocationMatch fieldLocationMatch,
 CAI1ComparisonExact<com.io7m.cedarbridge.runtime.api.CBUUID> fieldItemMatch,
 com.io7m.cedarbridge.runtime.api.CBList<CAI1StockOccurrenceKind> fieldIncludeOccurrences,
 com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned32 fieldPageSize)

Creates an instance of a CAI1StockSearchParameters record class.

Parameters:

fieldLocationMatch - the value for the fieldLocationMatch record component

fieldItemMatch - the value for the fieldItemMatch record component

fieldIncludeOccurrences - the value for the fieldIncludeOccurrences record component

fieldPageSize - the value for the fieldPageSize record component

Method Details

serialize

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

Serialize a value of type CAI1StockSearchParameters.

Parameters:

$context - The serialization context.

$x - The value to be serialized.

Throws:

IOException

deserialize

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

Deserialize a value of type CAI1StockSearchParameters.

Parameters:

$context - The serialization context.

Returns:

A value of type CAI1StockSearchParameters.

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.

fieldLocationMatch

public CAI1LocationMatch fieldLocationMatch()

Returns the value of the fieldLocationMatch record component.

Returns:

the value of the fieldLocationMatch record component

fieldItemMatch

public CAI1ComparisonExact<com.io7m.cedarbridge.runtime.api.CBUUID> fieldItemMatch()

Returns the value of the fieldItemMatch record component.

Returns:

the value of the fieldItemMatch record component

fieldIncludeOccurrences

public com.io7m.cedarbridge.runtime.api.CBList<CAI1StockOccurrenceKind> fieldIncludeOccurrences()

Returns the value of the fieldIncludeOccurrences record component.

Returns:

the value of the fieldIncludeOccurrences record component

fieldPageSize

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

Returns the value of the fieldPageSize record component.

Returns:

the value of the fieldPageSize record component