org.jquantlib.currencies

Class Money

java.lang.Object

org.jquantlib.currencies.Money

All Implemented Interfaces:

java.lang.Cloneable

public class Money
extends java.lang.Object
implements java.lang.Cloneable

Cash amount in a given currency.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Money.ConversionType

Field Summary

Fields

Modifier and Type	Field and Description
static Currency	baseCurrency
static Money.ConversionType	conversionType

Constructor Summary

Constructors

Constructor and Description
Money()
Money(Currency currency, double value)
Money(double value, Currency currency)

Method Summary

Modifier and Type	Method and Description
Money	add(Money money)
Money	addAssign(Money money) += Operator
Money	clone()
boolean	close_enough(Money money, int n)
boolean	close(Money money, int n)
void	convertTo(Currency target)
void	convertToBase()
Currency	currency()
Money	div(double x)
double	div(Money money) Returns the the value of this instance divided by another instance.
Money	divAssign(double x)
boolean	equals(Money money) Operator ==
boolean	greater(Money money)
boolean	greaterEqual(Money money)
boolean	less(Money money)
boolean	lessEquals(Money money)
Money	mul(double x)
Money	mulAssign(double x)
static Money	multiple(Currency c, double value)
static Money	multiple(double value, Currency c)
Money	negativeValue()
boolean	notEquals(Money money)
Money	operatorMultiply(double value, Currency c)
Money	positiveValue()
Money	rounded()
Money	sub(Money money)
Money	subAssign(Money money) -= Operator
java.lang.String	toString()
double	value()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

conversionType

public static Money.ConversionType conversionType

baseCurrency

public static Currency baseCurrency

Constructor Detail

Money

public Money()

Money

public Money(Currency currency,
             double value)

Money

public Money(double value,
             Currency currency)

Method Detail

clone

public Money clone()

Overrides:

clone in class java.lang.Object

currency

public Currency currency()

value

public double value()

rounded

public Money rounded()

positiveValue

public Money positiveValue()

negativeValue

public Money negativeValue()

mulAssign

public Money mulAssign(double x)

divAssign

public Money divAssign(double x)

add

public Money add(Money money)

sub

public Money sub(Money money)

mul

public Money mul(double x)

div

public Money div(double x)

notEquals

public boolean notEquals(Money money)

greater

public boolean greater(Money money)

greaterEqual

public boolean greaterEqual(Money money)

operatorMultiply

public Money operatorMultiply(double value,
                              Currency c)

multiple

public static Money multiple(Currency c,
                             double value)

multiple

public static Money multiple(double value,
                             Currency c)

convertTo

public void convertTo(Currency target)

convertToBase

public void convertToBase()

addAssign

public Money addAssign(Money money)

+= Operator

Parameters:

money - The money to be added.

Returns:

This money instance increased by the specified amount.

subAssign

public Money subAssign(Money money)

-= Operator

Parameters:

money - The money to be subtracted.

Returns:

This money instance decreased by the specified amount.

div

public double div(Money money)

Returns the the value of this instance divided by another instance.

Parameters:

money - The amount this instance should be divided to.

Returns:

The amount of this divided by money.

equals

public boolean equals(Money money)

Operator ==

Parameters:

money - The instance this instance should be compared to.

Returns:

Whether this instance is equal to another instance

less

public boolean less(Money money)

lessEquals

public boolean lessEquals(Money money)

close

public boolean close(Money money,
                     int n)

close_enough

public boolean close_enough(Money money,
                            int n)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object