Record Class CurrencyDTO

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.platform.models.api.dto.locale.CurrencyDTO

Record Components:

code - currency code

isoCode - ISO 4217 currency code

label - display label

symbol - currency symbol

public record CurrencyDTO(String code, String isoCode, String label, String symbol)
extends Record

DTO representation of a Currency.

Version:

2.0.2

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
CurrencyDTO(String code, String isoCode, String label, String symbol)	Creates an instance of a CurrencyDTO record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static CurrencyDTO	from(Currency currency)	Converts a Currency to a CurrencyDTO.
final int	hashCode()	Returns a hash code value for this object.
String	isoCode()	Returns the value of the isoCode record component.
String	label()	Returns the value of the label record component.
String	symbol()	Returns the value of the symbol record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CurrencyDTO

public CurrencyDTO(String code,
 String isoCode,
 String label,
 String symbol)

Creates an instance of a CurrencyDTO record class.

Parameters:

code - the value for the code record component

isoCode - the value for the isoCode record component

label - the value for the label record component

symbol - the value for the symbol record component

Method Details

from

public static CurrencyDTO from(Currency currency)

Converts a Currency to a CurrencyDTO.

Parameters:

currency - Currency

Returns:

CurrencyDTO

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.

code

public String code()

Returns the value of the code record component.

Returns:

the value of the code record component

isoCode

public String isoCode()

Returns the value of the isoCode record component.

Returns:

the value of the isoCode record component

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component

symbol

public String symbol()

Returns the value of the symbol record component.

Returns:

the value of the symbol record component