org.salespointframework.core.money

Class Money

java.lang.Object

org.salespointframework.core.quantity.Quantity

org.salespointframework.core.money.Money

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Quantity>

public final class Money
extends Quantity

The Money class represents the Euro currency. A suitable Metric and RoundingStrategy is created automatically. A user-defined Metric can be supplied. The default Metric is Euro. Arithmetic functions are used from the Quantity class. The internal representation uses four digits after the decimal separator.

Author:

Hannes Weisbach

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Metric	EURO Convenience instance, used for the euro currency.
static Money	ONE Convenience instance, having a value of 1.
static Money	OVER9000 Convenience instance, having a very high value.
static Money	ZERO Convenience instance, having a value of 0.

Constructor Summary

Constructors

Constructor and Description
Money(java.math.BigDecimal amount) Constructs a new Money object from a BigDecimal .
Money(java.math.BigDecimal amount, Metric metric) Creates a new Money instance from an amount and a metric.
Money(double amount) Constructs a new Money object from a double value
Money(double amount, Metric metric) Creates a new Money instance from an amount and a metric.
Money(int amount, Metric metric) Creates a new Money instance from an amount and a metric.
Money(long amount) Constructs a new Money object from a long value

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString() String representation of the monetary value represented by this.

Methods inherited from class org.salespointframework.core.quantity.Quantity

add, clone, compareTo, divide, equals, getAmount, getMetric, getRoundingStrategy, greaterThan, hashCode, isNegative, lessThan, multiply, subtract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EURO

public static final Metric EURO

Convenience instance, used for the euro currency. The name is "Euro", the symbol is "€" and the definition is empty.

ZERO

public static final Money ZERO

Convenience instance, having a value of 0.

ONE

public static final Money ONE

Convenience instance, having a value of 1.

OVER9000

public static final Money OVER9000

Convenience instance, having a very high value. Also an easteregg.

Constructor Detail

Money

public Money(java.math.BigDecimal amount,
     Metric metric)

Creates a new Money instance from an amount and a metric.

Parameters:

amount - amount of the money represented by this instance

metric - metric (currency) to be used for this instance.

Money

public Money(int amount,
     Metric metric)

Creates a new Money instance from an amount and a metric.

Parameters:

amount - amount of the money represented by this instance

metric - metric (currency) to be used for this instance.

Money

public Money(double amount,
     Metric metric)

Creates a new Money instance from an amount and a metric.

Parameters:

amount - amount of the money represented by this instance

metric - metric (currency) to be used for this instance.

Money

public Money(java.math.BigDecimal amount)

Constructs a new Money object from a BigDecimal .

Parameters:

amount - the amount of money represented by this

Money

public Money(long amount)

Constructs a new Money object from a long value

Parameters:

amount - the amount of money represented by this

Money

public Money(double amount)

Constructs a new Money object from a double value

Parameters:

amount - the amount of money represented by this¸

Method Detail

toString

public java.lang.String toString()

String representation of the monetary value represented by this. The numerical value is truncated after two digits after the decimal separator and followed by a whitespace and the symbol stored in metric.

Overrides:

toString in class Quantity