org.djunits.unit

Class MoneyUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<MoneyUnit>

org.djunits.unit.MoneyUnit

All Implemented Interfaces:

Serializable

public class MoneyUnit
extends LinearUnit<MoneyUnit>

MoneyUnit defines a monetary unit, and wraps the joda money currency unit. At this time, conversion rates between monetary units are not used. A standard monetary unit, defined as a static variable, can be set to be used in the code.

Copyright (c) 2015-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version Sep 03, 2015

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MoneyUnit	AUD The currency 'AUD' - Australian Dollar.
static MoneyUnit	CAD The currency 'CAD' - Canadian Dollar.
static MoneyUnit	CHF The currency 'CHF' - Swiss Franc.
static MoneyUnit	EUR The currency 'EUR' - Euro.
static MoneyUnit	GBP The currency 'GBP' - British pound.
static MoneyUnit	JPY The currency 'JPY' - Japanese Yen.
static MoneyUnit	USD The currency 'USD' - United States Dollar.

Fields inherited from class org.djunits.unit.Unit

scale, STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
MoneyUnit(org.joda.money.CurrencyUnit currencyUnit, String name, String abbreviation) Build a user-defined money unit.
MoneyUnit(org.joda.money.CurrencyUnit currencyUnit, String name, String abbreviation, MoneyUnit referenceUnit, double conversionFactorToReferenceUnit) Build a user-defined money unit based on another money unit with a conversion factor.

Method Summary

Modifier and Type	Method and Description
org.joda.money.CurrencyUnit	getCurrencyUnit()
String	getSICoefficientsString()
static MoneyUnit	getStandardMoneyUnit()
MoneyUnit	getStandardUnit()
static void	setStandardUnit(MoneyUnit moneyUnit) Set the standard money unit to be used.

Methods inherited from class org.djunits.unit.LinearUnit

getConversionFactorToStandardUnit, getScale

Methods inherited from class org.djunits.unit.Unit

equals, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getName, getNameKey, getSICoefficients, getUnits, getUnitSystem, hashCode, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUD

public static final MoneyUnit AUD

The currency 'AUD' - Australian Dollar.

CAD

public static final MoneyUnit CAD

The currency 'CAD' - Canadian Dollar.

CHF

public static final MoneyUnit CHF

The currency 'CHF' - Swiss Franc.

EUR

public static final MoneyUnit EUR

The currency 'EUR' - Euro.

GBP

public static final MoneyUnit GBP

The currency 'GBP' - British pound.

JPY

public static final MoneyUnit JPY

The currency 'JPY' - Japanese Yen.

USD

public static final MoneyUnit USD

The currency 'USD' - United States Dollar.

Constructor Detail

MoneyUnit

public MoneyUnit(org.joda.money.CurrencyUnit currencyUnit,
                 String name,
                 String abbreviation)

Build a user-defined money unit.

Parameters:

currencyUnit - the joda-money CurrencyUnit on which this djunits unit is based

name - the long name of the unit

abbreviation - the abbreviation of the unit

MoneyUnit

public MoneyUnit(org.joda.money.CurrencyUnit currencyUnit,
                 String name,
                 String abbreviation,
                 MoneyUnit referenceUnit,
                 double conversionFactorToReferenceUnit)

Build a user-defined money unit based on another money unit with a conversion factor.

Parameters:

currencyUnit - the joda-money CurrencyUnit on which this djunits unit is based

name - the long name of the unit

abbreviation - the abbreviation of the unit

referenceUnit - the unit to convert to

conversionFactorToReferenceUnit - multiply a value in this unit by the factor to convert to the given reference unit

Method Detail

getCurrencyUnit

public final org.joda.money.CurrencyUnit getCurrencyUnit()

Returns:

the joda-money CurrencyUnit on which this djunits unit is based.

setStandardUnit

public static final void setStandardUnit(MoneyUnit moneyUnit)

Set the standard money unit to be used.

Parameters:

moneyUnit - the new standard money unit.

getStandardUnit

public final MoneyUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<MoneyUnit>

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getStandardMoneyUnit

public static final MoneyUnit getStandardMoneyUnit()

Returns:

the current standard money unit

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<MoneyUnit>

Returns:

the SI standard coefficients for this unit, e.g., kgm/s2 or m-2s2A or m^-2.s^2.A or m^-2s^2A (not necessarily normalized)