Record Class CJ1MetadataMonetary

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.json.internal.CJ1MetadataMonetary

All Implemented Interfaces:

CJ1MetadataType, CJ1ValueType

@JsonClassDescription("A monetary metadata value.")
public record CJ1MetadataMonetary(CJ1TypeRecordFieldIdentifier name, BigDecimal value, org.joda.money.CurrencyUnit currency)
extends Record
implements CJ1MetadataType

Constructor Summary

Constructors

Constructor	Description
CJ1MetadataMonetary(CJ1TypeRecordFieldIdentifier name, BigDecimal value, org.joda.money.CurrencyUnit currency)	Creates an instance of a CJ1MetadataMonetary record class.

Method Summary

Modifier and Type	Method	Description
org.joda.money.CurrencyUnit	currency()	Returns the value of the currency record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
CJ1TypeRecordFieldIdentifier	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
BigDecimal	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Constructor Details

CJ1MetadataMonetary

public CJ1MetadataMonetary(@JsonPropertyDescription("The metadata field name.")
 CJ1TypeRecordFieldIdentifier name,
 @JsonPropertyDescription("The metadata value.")
 BigDecimal value,
 @JsonPropertyDescription("The metadata currency value.")
 org.joda.money.CurrencyUnit currency)

Creates an instance of a CJ1MetadataMonetary record class.

Parameters:

name - the value for the name record component

value - the value for the value record component

currency - the value for the currency 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.

name

@JsonPropertyDescription("The metadata field name.")
public CJ1TypeRecordFieldIdentifier name()

Returns the value of the name record component.

Returns:

the value of the name record component

value

@JsonPropertyDescription("The metadata value.")
public BigDecimal value()

Returns the value of the value record component.

Returns:

the value of the value record component

currency

@JsonPropertyDescription("The metadata currency value.")
public org.joda.money.CurrencyUnit currency()

Returns the value of the currency record component.

Returns:

the value of the currency record component