Money

Instance Constructors

new Money(ccy: A, qty: QTY, dov: DATE)

ccy
The currency of the monetary value.
qty
The quantity of the monetary value.
dov
The date the monetary value is effective as of.

Value Members

def !+:![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[B]

Provides an addition operation with conversion semantics preserving right operand's currency in the return value.
Provides an addition operation with conversion semantics preserving right operand's currency in the return value.
B
The type parameter defining the currency of the right operand.
o
The monetary value to add to this.
converter
The implicit foreign exchange rate converter.
returns
Some monetary value instance as the sum of two operands if foreign exchange rate is defined, None otherwise.
def !-:![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[B]

Provides a subtraction operation with conversion semantics preserving right operand's currency in the return value.
Provides a subtraction operation with conversion semantics preserving right operand's currency in the return value.
B
The type parameter defining the currency of the right operand.
o
The monetary value to subtract from this.
converter
The implicit foreign exchange rate converter.
returns
Some monetary value instance as the difference of two operands if foreign exchange rate is defined, None otherwise.
def !/![B <: CCY](o: Money[B])(implicit converter: Converter): Option[QTY]

Provides a monetary division operation.
Provides a monetary division operation.
o
The divisor.
returns
Some of the ratio if conversion is required and successful, None otherwise.
def !:+![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[A]

Provides an addition operation with conversion semantics preserving left operand's currency in the return value.
Provides an addition operation with conversion semantics preserving left operand's currency in the return value.
B
The type parameter defining the currency of the right operand.
o
The monetary value to add to this.
converter
The implicit foreign exchange rate converter.
returns
Some monetary value instance as the sum of two operands if foreign exchange rate is defined, None otherwise.
def !:-![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[A]

Provides a subtraction operation with conversion semantics preserving left operand's currency in the return value.
Provides a subtraction operation with conversion semantics preserving left operand's currency in the return value.
B
The type parameter defining the currency of the right operand.
o
The monetary value to subtract from this.
converter
The implicit foreign exchange rate converter.
returns
Some monetary value instance as the difference of two operands if foreign exchange rate is defined, None otherwise.
final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def %%[B <: CCY](to: B)(implicit converter: Converter): OptMoney[B]

Converts the monetary value instance to a new one with target currency.
Converts the monetary value instance to a new one with target currency.
B
The Currency type which the conversion will be targeted at.
to
Target currency.
returns
An optional new monetary value instance if the conversion is successful, None otherwise.
def %*%[B <: CCY](rate: Rate[A, B]): Money[B]

Returns the converted monetary value as of the given foreign exchange rate.
Returns the converted monetary value as of the given foreign exchange rate.
rate
Foreign exchange rate.
returns
A new Money instance which is converted from this.
def %/%[B <: CCY](rate: Rate[B, A]): Money[B]

Returns the converted monetary value as of the given foreign exchange rate.
Returns the converted monetary value as of the given foreign exchange rate.
rate
Foreign exchange rate.
returns
A new Money instance which is converted from this.
def *(o: QTY): Money[A]

Provides a scalar multiplication operation.
Provides a scalar multiplication operation.
o
The scalar term to be multiplied with the quantity of this.
returns
A new Money instance of which the quantity is the multiplication of o and the quantity of this.
def +(o: QTY): Money[A]

Provides a scalar addition operation.
Provides a scalar addition operation.
o
The scalar term to be added to the quantity of this.
returns
A new Money instance of which the quantity is the sum of the quantity of this and o.
def -(o: QTY): Money[A]

Provides a scalar subtraction operation.
Provides a scalar subtraction operation.
o
The scalar term to be subtracted from the quantity of this.
returns
A new Money instance of which the quantity is the subtraction of o from the quantity of this.
def /(o: QTY): Money[A]

Provides a scalar division operation.
Provides a scalar division operation.
o
The scalar term by which to divide the quantity of this.
returns
A new Money instance of which the quantity is the division of the quantity of this by o.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def abs(): Money[A]

Returns the absolute monetary value.
Returns the absolute monetary value.
returns
A new Money instance of which the quantity is the absolute quantity of this.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val ccy: A

The currency of the monetary value.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def cmap[B <: CCY](f: (A) ⇒ B): Money[B]

Provides a function to map a given function over the currency and return a new monetary value instance.
Provides a function to map a given function over the currency and return a new monetary value instance.
B
The type parameter defining the new currency to be produced.
f
Function which consumes the currency of the monetary value and returns a new currency.
returns
A new Money instance of which the currency is defined by the application of the f function.
def dmap(f: (DATE) ⇒ DATE): Money[A]

Provides a function to map a given function over the date of value and return a new monetary value instance.
Provides a function to map a given function over the date of value and return a new monetary value instance.
f
Function which consumes the date of value and returns a new date of value.
returns
New Money instance of which the date of value is defined by the application of the f function.
val dov: DATE

The date the monetary value is effective as of.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def inv(): Money[A]

Returns the inverted monetary value (by qty' => 1 / qty).
Returns the inverted monetary value (by qty' => 1 / qty).
returns
A new Money instance of which the quantity is the inverted quantity of this.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pow(n: Int): Money[A]

Returns the exponentiated monetary value.
Returns the exponentiated monetary value.
n
The exponent.
returns
A new Money instance of which the quantity is the exponentiation of the quantity of this by n.
def qbi(f: (QTY, QTY) ⇒ QTY)(o: QTY): Money[A]

Defines a function which creates a binary, scalar function, applies to this and o and return a new monetary value.
Defines a function which creates a binary, scalar function, applies to this and o and return a new monetary value.
f
The binary, scalar function.
o
The scalar term.
returns
A new Money instance of which the quantity is defined by the application of the f function.
def qmap(f: (QTY) ⇒ QTY): Money[A]

Provides a function to map a given function over the quantity and return a new monetary value instance.
Provides a function to map a given function over the quantity and return a new monetary value instance.
f
Function which consumes the quantity and returns a new quantity.
returns
New Money instance of which the quantity is defined by the application of the f function.
val qty: QTY

The quantity of the monetary value.
def quantize: Money[A]

Removes redundant precision by properly rounding Money.qty as per Money.ccy type.
Removes redundant precision by properly rounding Money.qty as per Money.ccy type.
returns
A new Money instance of which the quantity is the quantized quantity of this.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def unary_-(): Money[A]

Returns the negated monetary value.
Returns the negated monetary value.
returns
A new Money instance of which the quantity is the negated quantity of this.
def vmap[B <: CCY](f: (A, QTY, DATE) ⇒ Money[B]): Money[B]

Provides a function to map a given function over the value slots and return a new monetary value instance.
Provides a function to map a given function over the value slots and return a new monetary value instance.
B
Specific Currency type which is returned by the f function.
f
Function which consumes a tuple of all value slots and returns a new monetary value instance.
returns
A new Money instance as returned by the f function.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def |+|(o: Money[A]): Money[A]

Provides a simple monetary addition operation over same currency monetary values.
Provides a simple monetary addition operation over same currency monetary values.
o
Monetary value to be added.
returns
A new Money instance which is the addition of two monetary values.
def |-|(o: Money[A]): Money[A]

Provides a simple monetary subtraction operation over same currency monetary values.
Provides a simple monetary subtraction operation over same currency monetary values.
o
Monetary value to be subtracted.
returns
A new Money instance which is the subtraction of two monetary values.
def |/|(o: Money[A]): QTY

Provides a simple monetary division operation over same currency monetary values.
Provides a simple monetary division operation over same currency monetary values.
o
Monetary value to divide this by.
returns
The ratio of quantities of the two monetary value instances.

Related Docs: object Money | package parala

final case class Money[A <: Currency](ccy: A, qty: QTY, dov: DATE) extends Product with Serializable

Instance Constructors

new Money(ccy: A, qty: QTY, dov: DATE)

Value Members

def !+:![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[B]

def !-:![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[B]

def !/![B <: CCY](o: Money[B])(implicit converter: Converter): Option[QTY]

def !:+![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[A]

def !:-![B <: CCY](o: Money[B])(implicit converter: Converter): OptMoney[A]

final def !=(arg0: Any): Boolean

final def ##(): Int

def %%[B <: CCY](to: B)(implicit converter: Converter): OptMoney[B]

def %*%[B <: CCY](rate: Rate[A, B]): Money[B]

def %/%[B <: CCY](rate: Rate[B, A]): Money[B]

def *(o: QTY): Money[A]

def +(o: QTY): Money[A]

def -(o: QTY): Money[A]

def /(o: QTY): Money[A]

final def ==(arg0: Any): Boolean

def abs(): Money[A]

final def asInstanceOf[T0]: T0

val ccy: A

def clone(): AnyRef

def cmap[B <: CCY](f: (A) ⇒ B): Money[B]

def dmap(f: (DATE) ⇒ DATE): Money[A]

val dov: DATE

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def inv(): Money[A]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pow(n: Int): Money[A]

def qbi(f: (QTY, QTY) ⇒ QTY)(o: QTY): Money[A]

def qmap(f: (QTY) ⇒ QTY): Money[A]

val qty: QTY

def quantize: Money[A]

final def synchronized[T0](arg0: ⇒ T0): T0

def unary_-(): Money[A]

def vmap[B <: CCY](f: (A, QTY, DATE) ⇒ Money[B]): Money[B]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def |+|(o: Money[A]): Money[A]

def |-|(o: Money[A]): Money[A]

def |/|(o: Money[A]): QTY

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped