Money/com.eriksencosta.money/CirculatingCurrency

CirculatingCurrency

class CirculatingCurrency : StandardizedCurrency(source)

Represents a circulating currency. De facto currencies, albeit not ISO-standardized, are also available (e.g., CNH for Hong Kong's Renminbi).

Besides the currently standardized ISO 4217 currencies, historical currencies can also be created (e.g., FRF for the French Franc, ITL for the Italian Lira, SUR the for Soviet Union Rouble, and so on).

Types

Type

enum Type : Enum<CirculatingCurrency.Type> , CurrencyType

Represents the type of CirculatingCurrency.

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.

toCustomCurrency

fun toCustomCurrency(minorUnits: Int): CustomCurrency

Creates a CustomCurrency based on this instance data.

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.