Money/com.eriksencosta.money/Money

Money

class Money : Comparable<Money> (source)

Represents a monetary value.

Money is an implementation of the pattern with the same name and provides methods for mathematical operations, allocation, and currency exchange rate. The Money type is intended to be used as a base data type.

Types

Factory

object Factory

A Money factory.

Properties

amount

val amount: BigDecimal

The monetary amount.

currency

val currency: Currency

The monetary currency.

hasRounding

val hasRounding: Boolean

true if it has rounding support.

isNegative

val isNegative: Boolean

true if the monetary amount is negative.

isNegativeOrZero

val isNegativeOrZero: Boolean

true if the monetary amount is negative or zero.

isNotZero

val isNotZero: Boolean

true if the monetary amount is not zero.

isPositive

val isPositive: Boolean

true if the monetary amount is positive.

isPositiveOrZero

val isPositiveOrZero: Boolean

true if the monetary amount is positive or zero.

isZero

val isZero: Boolean

true if the monetary amount is zero.

Functions

allocate

infix fun Money.allocate(by: AllocationBy): Result

Allocates a Money according to the by parameter:

fun Money.allocate(vararg ratios: Percentage): Result

infix fun Money.allocate(ratios: List<Percentage>): Result

Allocates a Money in ratios. Example:

infix fun Money.allocate(parts: Int): Result

Allocates a Money in equal parts. Example:

compareTo

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

decreaseBy

infix fun Money.decreaseBy(by: Percentage): Money

Decreases this Money by the given Percentage.

div

operator fun div(by: Number): Money

Divides this Money.

equals

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

exchange

infix fun Money.exchange(rate: Money): Money

Converts a Money to another currency by the given exchange rate. Calculations using the resulting Money will be rounded with the strategy of the given rate object.

hashCode

open override fun hashCode(): Int

increaseBy