Money/com.eriksencosta.money/CustomCurrency

CustomCurrency

class CustomCurrency : Currency(source)

Represents a custom currency identified by a code. This object can be used to represent:

A currency that is not standardized (e.g., new cryptocurrencies or currencies from unrecognized or partially recognized countries)
A standardized currency with enough minor units (i.e., decimal places) to model amounts like exchange rates and fuel prices

Types

CustomCurrencyConfig

class CustomCurrencyConfig

Configuration options for a CustomCurrency used by the Currency.custom method.

Type

enum Type : Enum<CustomCurrency.Type> , CurrencyType

Represents the type of CustomCurrency.

Properties

code

val code: String

The code of the currency.

minorUnits

val minorUnits: Int

The minor units (i.e., the decimal places) of the currency.

name

val name: String

The name of the currency.

secondaryCode

val secondaryCode: String

The secondary code of the currency

symbol

val symbol: String

The graphical symbol of the currency.

type

open val type: CurrencyType

The type of the currency.

Functions

compareTo

open operator override fun compareTo(other: Currency): Int

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

money

infix fun Currency.money(amount: Number): Money

Creates a Money based on this Currency. Example:

infix fun Currency.money(values: Iterable<Number>): Iterable<Money>

Transforms a collection of Number into Money based on this Currency. Calculations using them are rounded using a Rounding strategy configured with RoundingMode.HALF_EVEN.

fun Currency.money(amount: Number, mode: RoundingMode): Money

Creates a Money based on this Currency. Calculations using it are rounded using a Rounding strategy configured with the specified mode.

fun Currency.money(values: Iterable<Number>, mode: RoundingMode): Iterable<Money>

Transforms a collection of Number into Money based on this Currency. Calculations using them are rounded using a Rounding strategy configured with the specified mode.

smallestUnit

fun Currency.smallestUnit(): Money

Creates a Money representing the smallest unit of value based on this Currency. Example:

fun Currency.smallestUnit(mode: RoundingMode): Money

Creates a Money representing the smallest unit of value based on this Currency. Calculations using it are rounded using a Rounding strategy configured with the specified mode.

toDetailedString

fun Currency.toDetailedString(): String

Returns a string representation of the object, including all public properties.

toString

open override fun toString(): String

zero

fun Currency.zero(): Money

Creates a Money based on this Currency with its amount set to zero. Example:

infix fun Currency.zero(mode: RoundingMode): Money

Creates a Money based on this Currency with its amount set to zero. Calculations using it are rounded using a Rounding strategy configured with the specified mode.