Class Money

    • Method Detail

      • zero

        public static Money zero​(Currency currency)
        Obtains a zero amount instance of Money for the specified currency.
        Parameters:
        currency - the currency the amount is in
        Returns:
        the zero amount instance
      • of

        public static Money of​(CurrencyAmount currencyAmount)
        Obtains an instance of Money for the specified CurrencyAmount.
        Parameters:
        currencyAmount - the instance of CurrencyAmount wrapping the currency and amount.
        Returns:
        the currency amount
      • of

        public static Money of​(Currency currency,
                               double amount)
        Obtains an instance of Money for the specified currency and amount.
        Parameters:
        currency - the currency the amount is in
        amount - the amount of the currency to represent
        Returns:
        the currency amount
      • of

        public static Money of​(Currency currency,
                               BigDecimal amount)
        Obtains an instance of Money for the specified currency and amount.
        Parameters:
        currency - the currency the amount is in
        amount - the amount of the currency to represent, as an instance of BigDecimal
        Returns:
        the currency amount
      • parse

        public static Money parse​(String amountStr)
        Parses the string to produce a Money.

        This parses the toString format of '${currency} ${amount}'.

        Parameters:
        amountStr - the amount string
        Returns:
        the currency amount
        Throws:
        IllegalArgumentException - if the amount cannot be parsed
      • getCurrency

        public Currency getCurrency()
        Gets the currency.

        For example, in the value 'GBP 12.34' the currency is 'GBP'.

        Returns:
        the currency
      • getAmount

        public BigDecimal getAmount()
        Gets the amount of the currency.

        The amount will be rounded to the currency specifications.

        For example, in the value 'GBP 12.34' the amount is 12.34.

        Returns:
        the amount
      • plus

        public Money plus​(Money amountToAdd)
        Returns a copy of this Money with the specified amount added.

        This adds the specified amount to this monetary amount, returning a new object.

        This instance is immutable and unaffected by this method.

        Parameters:
        amountToAdd - the amount to add, in the same currency
        Returns:
        an amount based on this with the specified amount added
        Throws:
        IllegalArgumentException - if the currencies are not equal
      • minus

        public Money minus​(Money amountToSubtract)
        Returns a copy of this Money with the specified amount subtracted.

        This subtracts the specified amount to this monetary amount, returning a new object.

        This instance is immutable and unaffected by this method.

        Parameters:
        amountToSubtract - the amount to subtract, in the same currency
        Returns:
        an amount based on this with the specified amount subtracted
        Throws:
        IllegalArgumentException - if the currencies are not equal
      • multipliedBy

        public Money multipliedBy​(long valueToMultiplyBy)
        Returns a copy of this Money with the amount multiplied.

        This takes this amount and multiplies it by the specified value.

        This instance is immutable and unaffected by this method.

        Parameters:
        valueToMultiplyBy - the scalar amount to multiply by
        Returns:
        an amount based on this with the amount multiplied
      • isZero

        public boolean isZero()
        Checks if the amount is zero.
        Returns:
        true if zero
      • isPositive

        public boolean isPositive()
        Checks if the amount is positive.

        Zero and negative amounts return false.

        Returns:
        true if positive
      • isNegative

        public boolean isNegative()
        Checks if the amount is negative.

        Zero and positive amounts return false.

        Returns:
        true if negative
      • toCurrencyAmount

        public CurrencyAmount toCurrencyAmount()
        Converts this monetary amount to the equivalent CurrencyAmount.
        Returns:
        the equivalent CurrencyAmount
      • convertedTo

        public Money convertedTo​(Currency resultCurrency,
                                 BigDecimal fxRate)
        Converts this amount to an equivalent amount the specified currency.

        The result will be expressed in terms of the given currency, converting using the specified FX rate.

        For example, if this represents 'GBP 100' and this method is called with arguments (USD, 1.6) then the result will be 'USD 160'.

        Parameters:
        resultCurrency - the currency of the result
        fxRate - the FX rate from this currency to the result currency
        Returns:
        the converted instance, which should be expressed in the specified currency
        Throws:
        IllegalArgumentException - if the FX is not 1 when no conversion is required
      • convertedTo

        public Money convertedTo​(Currency resultCurrency,
                                 FxRateProvider rateProvider)
        Converts this amount to an equivalent amount in the specified currency.

        The result will be expressed in terms of the given currency. If conversion is needed, the provider will be used to supply the FX rate.

        Specified by:
        convertedTo in interface FxConvertible<Money>
        Parameters:
        resultCurrency - the currency of the result
        rateProvider - the provider of FX rates
        Returns:
        the converted instance, in the specified currency
        Throws:
        RuntimeException - if no FX rate could be found
      • compareTo

        public int compareTo​(Money other)
        Compares this money to another.

        This compares currencies alphabetically, then by amount.

        Specified by:
        compareTo in interface Comparable<Money>
        Parameters:
        other - the other amount
        Returns:
        negative if less, zero if equal, positive if greater
      • equals

        public boolean equals​(Object obj)
        Checks if this money equals another.
        Overrides:
        equals in class Object
        Parameters:
        obj - the other amount, null returns false
        Returns:
        true if equal
      • hashCode

        public int hashCode()
        Returns a suitable hash code for the currency.
        Overrides:
        hashCode in class Object
        Returns:
        the hash code
      • toString

        public String toString()
        Gets the amount as a string.

        The format is the currency code, followed by a space, followed by the amount: '${currency} ${amount}'.

        Overrides:
        toString in class Object
        Returns:
        the currency amount