squants.market

Money

final class Money extends Quantity[Money]

Represents a quantity of Money.

Money is similar to other quantities in that it represents an amount of something - purchasing power - and it is measured in units - currencies.

The main difference is that the conversion rate between currencies can not be certain at compile. (In fact it may not always be so easy to know them at runtime as well.)

To address this diversion from the way most other quantities work, Money overrides several of the standard methods and operators to ensure one of two rules is followed:

1) this and that are in the same currency, or 2) there is in an implicit MoneyContext in scope (which may or may not have the applicable exchange rate)

Methods and operations applied to moneys of different currencies may throw a NoSuchExchangeRateException if the implicit MoneyContext does not contain the Rate(s) necessary to perform the conversion.

The defaultMoneyContext includes USD as the default currency, a list of ~20 other currencies and NO exchange rates

Source
Money.scala
Since

0.1

Linear Supertypes
Quantity[Money], Ordered[Money], Comparable[Money], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Money
  2. Quantity
  3. Ordered
  4. Comparable
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. def !=#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  4. final def ##(): Int

    Definition Classes
    AnyRef → Any
  5. def %(that: BigDecimal): Money

    Integer divides this money by that BigDecimal and returns the remainder

    Integer divides this money by that BigDecimal and returns the remainder

    that

    BigDecimal

    returns

    Money

  6. def %(that: Money): Double

    Definition Classes
    Quantity
  7. def %(that: Double): Money

    Definition Classes
    Quantity
  8. def *(that: CurrencyExchangeRate): Money

    Multiplies this money by that squants.market.CurrencyExchangeRate and returns the equal value in the other currency.

    Multiplies this money by that squants.market.CurrencyExchangeRate and returns the equal value in the other currency.

    Delegates to CurrencyExchangeRate * Money

    that

    BigDecimal

    returns

  9. def *(that: BigDecimal): Money

    Multiplies this money by that BigDecimal and returns a new Money

    Multiplies this money by that BigDecimal and returns a new Money

    that

    BigDecimal

    returns

    Money

  10. def *(that: Double): Money

    Definition Classes
    Quantity
  11. def +(that: Money)(implicit context: MoneyContext = defaultMoneyContext): Money

    moneyPlus *

  12. def +(that: Money): Money

    Definition Classes
    Quantity
  13. def +-(that: Money): QuantityRange[Money]

    Definition Classes
    Quantity
  14. def -(that: Money)(implicit context: MoneyContext = defaultMoneyContext): Money

    moneyMinus *

  15. def -(that: Money): Money

    Definition Classes
    Quantity
  16. def ->: (Money) ⇒ CurrencyExchangeRate

    toThe

  17. def /[A <: Quantity[A]](that: A): Price[A]

    Divide this money by another (non-money) Quantity and return a Price

    Divide this money by another (non-money) Quantity and return a Price

    A

    Quantity Type

    that

    Quantity

    returns

    Price[A]

  18. def /(that: Money)(implicit context: MoneyContext = defaultMoneyContext): BigDecimal

  19. def /(that: BigDecimal): Money

    Divides this money by that BigDecimal and returns a new Money

    Divides this money by that BigDecimal and returns a new Money

    that

    BigDecimal

    returns

    Money

  20. def /(that: Money): Double

    Definition Classes
    Quantity
  21. def /(that: Double): Money

    Definition Classes
    Quantity
  22. def /%(that: BigDecimal): (Money, Money)

    Integer divides this money by that BigDecimal and returns the quotient and the remainder

    Integer divides this money by that BigDecimal and returns the quotient and the remainder

    that

    BigDecimal

    returns

    (Money, Money)

  23. def /%(that: Money): (Double, Money)

    Definition Classes
    Quantity
  24. def /%(that: Double): (Money, Money)

    Definition Classes
    Quantity
  25. def <(that: Money): Boolean

    Definition Classes
    Ordered
  26. def <#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  27. def <=(that: Money): Boolean

    Definition Classes
    Ordered
  28. def <=#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  29. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  30. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  31. def ==#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  32. def =~(that: Money)(implicit tolerance: Money): Boolean

    approx

    approx

    Definition Classes
    Quantity
  33. def >(that: Money): Boolean

    Definition Classes
    Ordered
  34. def >#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  35. def >=(that: Money): Boolean

    Definition Classes
    Ordered
  36. def >=#(that: Money)(implicit moneyContext: MoneyContext): Boolean

  37. def abs: Money

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  38. val amount: BigDecimal

    the amount of money

  39. def approx(that: Money)(implicit tolerance: Money): Boolean

    Returns boolean result of approximate equality comparison

    Returns boolean result of approximate equality comparison

    that

    Quantity

    tolerance

    Quantity

    returns

    Definition Classes
    Quantity
  40. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  41. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def compare(that: Money): Int

    Override for Quantity.

    Override for Quantity.compare to only work on Moneys of like Currency

    that

    Money

    returns

    Int

    Definition Classes
    MoneyQuantity → Ordered
  43. def compareTo(that: Money): Int

    Definition Classes
    Ordered → Comparable
  44. val currency: Currency

    the currency in which the money is denominated

  45. def dimension: Money.type

    The Dimension this quantity represents

    The Dimension this quantity represents

    returns

    Definition Classes
    MoneyQuantity
  46. def divide(that: Money): Double

    Override for Quantity.

    Override for Quantity.divide to only work on Moneys of like Currency Cross currency subtractions should use moneyMinus

    that

    Money

    returns

    Double

    Definition Classes
    MoneyQuantity
  47. def divide(that: Double): Money

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  48. def divideAndRemainder(that: Money): (Double, Money)

    Returns a Pair that includes the result of divideToInteger and remainder

    Returns a Pair that includes the result of divideToInteger and remainder

    that

    Quantity

    returns

    (Double, Quantity)

    Definition Classes
    Quantity
  49. def divideAndRemainder(that: Double): (Money, Money)

    Returns a Pair that includes the result of divideToInteger and remainder

    Returns a Pair that includes the result of divideToInteger and remainder

    that

    Double

    returns

    (Quantity, Quantity)

    Definition Classes
    Quantity
  50. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  51. def equals(that: Any): Boolean

    Override for Quantity.

    Override for Quantity.equal to only match Moneys of like Currency

    that

    Money must be of matching value and unit

    returns

    Definition Classes
    MoneyQuantity → AnyRef → Any
  52. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  53. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  54. def hashCode(): Int

    Override of hashCode

    Override of hashCode

    returns

    Definition Classes
    Quantity → AnyRef → Any
  55. def in(unit: Currency)(implicit context: MoneyContext): Money

    Reboxes this Money value in a Money in the given Currency

    Reboxes this Money value in a Money in the given Currency

    unit

    Currency

    context

    MoneyContext required for cross currency operations

    returns

    Money

    Exceptions thrown
    NoSuchExchangeRateException

    when no exchange rate is available

  56. def in(uom: UnitOfMeasure[Money]): Money

    Returns an equivalent Quantity boxed with the supplied Unit

    Returns an equivalent Quantity boxed with the supplied Unit

    uom

    UnitOfMeasure[A]

    returns

    Quantity

    Definition Classes
    Quantity
  57. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  58. def map(f: (Double) ⇒ Double): Money

    Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

    Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

    f

    Double => Double function

    returns

    Definition Classes
    Quantity
  59. def max(that: Money): Money

    Override for Quantity.

    Override for Quantity.max to only work on Moneys of like Currency

    that

    Money

    returns

    Int

    Definition Classes
    MoneyQuantity
  60. def min(that: Money): Money

    Override for Quantity.

    Override for Quantity.max to only work on Moneys of like Currency

    that

    Quantity

    returns

    Int

    Definition Classes
    MoneyQuantity
  61. def minus(that: Money): Money

    Override Quantity.

    Override Quantity.minus to only work on like currencies Cross currency subtractions should use moneyMinus

    that

    Money

    returns

    Money

    Definition Classes
    MoneyQuantity
    Exceptions thrown
    scala.UnsupportedOperationException

    when attempted on cross currencies

  62. def moneyCompare(that: Money)(implicit moneyContext: MoneyContext): Int

    Supports compare operation on Moneys of dislike Currency

    Supports compare operation on Moneys of dislike Currency

    that

    Money

    moneyContext

    MoneyContext

    returns

  63. def moneyDivide(that: Money)(implicit context: MoneyContext): BigDecimal

    Divides this money by that money and returns the ratio between the converted amounts

    Divides this money by that money and returns the ratio between the converted amounts

    that

    Money

    context

    MoneyContext

    returns

  64. def moneyEquals(that: Money)(implicit moneyContext: MoneyContext): Boolean

    Supports equality comparisons on Moneys of dislike Currency

    Supports equality comparisons on Moneys of dislike Currency

    that

    Money

    moneyContext

    MoneyContext

    returns

  65. def moneyMax(that: Money)(implicit moneyContext: MoneyContext): Money

    Supports max operation on Moneys of dislike Currency

    Supports max operation on Moneys of dislike Currency

    that

    Money

    moneyContext

    MoneyContext

    returns

  66. def moneyMin(that: Money)(implicit moneyContext: MoneyContext): Money

    Supports min operation on Moneys of dislike Currency

    Supports min operation on Moneys of dislike Currency

    that

    Money

    moneyContext

    MoneyContext

    returns

  67. def moneyMinus(that: Money)(implicit context: MoneyContext = defaultMoneyContext): Money

    Subtracts that Money from this Money converted to this.

    Subtracts that Money from this Money converted to this.currency via context

    that

    Money

    context

    MoneyContext required for cross currency operations

    returns

    Money

    Exceptions thrown
    NoSuchExchangeRateException

    when no exchange rate is available

  68. def moneyNotEquals(that: Money)(implicit moneyContext: MoneyContext): Boolean

    Supports non-equality comparisons on Moneys of dislike Currency

    Supports non-equality comparisons on Moneys of dislike Currency

    that

    Money

    moneyContext

    MoneyContext

    returns

  69. def moneyPlus(that: Money)(implicit context: MoneyContext = defaultMoneyContext): Money

    Adds this Money to that Money converted to this.

    Adds this Money to that Money converted to this.currency via context

    that

    Money

    context

    MoneyContext required for cross currency operations

    returns

    Money

    Exceptions thrown
    NoSuchExchangeRateException

    when no exchange rate is available

  70. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  71. def negate: Money

    Returns the negative value of this Quantity

    Returns the negative value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  72. def notWithin(range: QuantityRange[Money]): Boolean

    Returns true if this value is not within (contains) the range

    Returns true if this value is not within (contains) the range

    range

    QuantityRange

    returns

    Boolean

    Definition Classes
    Quantity
  73. final def notify(): Unit

    Definition Classes
    AnyRef
  74. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  75. def plus(that: Money): Money

    Overrides Quantity.

    Overrides Quantity.plus to only work on like currencies. Cross currency additions should use moneyPlus

    that

    Money

    returns

    Money

    Definition Classes
    MoneyQuantity
    Exceptions thrown
    scala.UnsupportedOperationException

    when attempted on cross currencies

  76. def plusOrMinus(that: Money): QuantityRange[Money]

    Returns a QuantityRange representing the range for this value +- that

    Returns a QuantityRange representing the range for this value +- that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  77. def remainder(that: Money): Double

    Returns the remainder of a division by a like quantity

    Returns the remainder of a division by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  78. def remainder(that: Double): Money

    Returns the remainder of a division by a number

    Returns the remainder of a division by a number

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  79. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  80. def times(that: Double): Money

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  81. def to(unit: Currency)(implicit context: MoneyContext): BigDecimal

    Convert this Money to a Double representing the currency unit

    Convert this Money to a Double representing the currency unit

    unit

    Currency

    context

    MoneyContext required for cross currency operations

    returns

    Double

    Exceptions thrown
    NoSuchExchangeRateException

    when no exchange rate is available

  82. def to(uom: UnitOfMeasure[Money]): Double

    Returns a Double representing the quantity in terms of the supplied unit

    Returns a Double representing the quantity in terms of the supplied unit

    val d = Feet(3)
    (d to Inches) should be(36)
    uom

    UnitOfMeasure[A]

    returns

    Double

    Definition Classes
    Quantity
  83. def to(that: Money): QuantityRange[Money]

    Returns a QuantityRange that goes from this to that

    Returns a QuantityRange that goes from this to that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  84. def toFormattedString(c: Currency)(implicit context: MoneyContext): String

  85. def toFormattedString: String

    Returns a string formatted with the value and currency symbol

    Returns a string formatted with the value and currency symbol

    eg USD(100) => "$100.00"

    returns

    String

  86. def toString(c: Currency)(implicit context: MoneyContext): String

  87. def toString(): String

    Returns a string formatted with the value and currency code

    Returns a string formatted with the value and currency code

    eg USD(100) => "100.00 USD"

    returns

    String

    Definition Classes
    MoneyQuantity → AnyRef → Any
  88. def toString(uom: UnitOfMeasure[Money], format: String): String

    Returns a string representing the quantity's value in the given unit in the given format

    Returns a string representing the quantity's value in the given unit in the given format

    uom

    UnitOfMeasure[A] with UnitConverter

    format

    String containing the format for the value (ie "%.3f")

    returns

    String

    Definition Classes
    Quantity
  89. def toString(uom: UnitOfMeasure[Money]): String

    Returns a string representing the quantity's value in the given unit

    Returns a string representing the quantity's value in the given unit

    uom

    UnitOfMeasure[A] with UnitConverter

    returns

    String

    Definition Classes
    Quantity
  90. def toThe(that: Money): CurrencyExchangeRate

    Combines with that Money to create an squants.market.CurrencyExchangeRate

    Combines with that Money to create an squants.market.CurrencyExchangeRate

    Exchange Rates on the same currency are not supported

    val rate: CurrencyExchangeRate = JPY(100) toThe USD(1)

    that

    Money

    returns
    Exceptions thrown
    scala.IllegalArgumentException

    if the that.currency matches this.currency

  91. def toTuple(uom: UnitOfMeasure[Money]): (Double, String)

    Returns a pair representing the numeric value and the uom's symbol

    Returns a pair representing the numeric value and the uom's symbol

    uom

    UnitOfMeasure[A]

    returns

    Definition Classes
    Quantity
  92. def toTuple: (Double, String)

    Returns a tuple representing the numeric value and the unit's symbol

    Returns a tuple representing the numeric value and the unit's symbol

    returns

    Definition Classes
    Quantity
  93. def unary_-(): Money

    Definition Classes
    Quantity
  94. def unit: Currency

    The Unit of Measure the value represents

    The Unit of Measure the value represents

    returns

    UnitOfMeasure[A]

    Definition Classes
    MoneyQuantity
  95. def value: Double

    The value of the quantity given the unit

    The value of the quantity given the unit

    returns

    Double

    Definition Classes
    MoneyQuantity
  96. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. def within(range: QuantityRange[Money]): Boolean

    Returns true if this value is within (contains) the range

    Returns true if this value is within (contains) the range

    range

    QuantityRange

    returns

    Boolean

    Definition Classes
    Quantity
  100. def ~=(that: Money)(implicit tolerance: Money): Boolean

    approx

    approx

    Definition Classes
    Quantity
  101. def (that: Money)(implicit tolerance: Money): Boolean

    approx

    approx

    Definition Classes
    Quantity

Inherited from Quantity[Money]

Inherited from Ordered[Money]

Inherited from Comparable[Money]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped