org.javamoney.moneta.spi

Class AbstractAmountFactory<T extends MonetaryAmount>

java.lang.Object

org.javamoney.moneta.spi.AbstractAmountFactory<T>

Type Parameters:

T - the target class implementing MonetaryAmount.

All Implemented Interfaces:

MonetaryAmountFactory<T>

Direct Known Subclasses:

FastMoneyAmountFactory, MoneyAmountFactory, RoundedMoneyAmountFactory

public abstract class AbstractAmountFactory<T extends MonetaryAmount>
extends Object
implements MonetaryAmountFactory<T>

Basic implementation of MonetaryAmountFactory, which simplifies development of the SPI interface.

Constructor Summary

Constructors

Constructor and Description
AbstractAmountFactory()

Method Summary

Modifier and Type	Method and Description
T	create() Creates a new instance of MonetaryAmount, using the default MonetaryContext.
protected abstract T	create(Number number, CurrencyUnit currency, MonetaryContext monetaryContext)
protected static BigDecimal	getBigDecimal(Number num) Deprecated. will be removed in next release
MonetaryContext	getDefaultMonetaryContext() Returns the default MonetaryContext used, when no MonetaryContext is provided.
MonetaryContext	getMaximalMonetaryContext() Returns the maximal MonetaryContext supported.
protected abstract MonetaryContext	loadDefaultMonetaryContext()
protected abstract MonetaryContext	loadMaxMonetaryContext()
MonetaryAmountFactory<T>	setAmount(MonetaryAmount smount) Converts (if necessary) the given MonetaryAmount to a new MonetaryAmount instance, hereby supporting the MonetaryContext given.
MonetaryAmountFactory<T>	setContext(MonetaryContext monetaryContext)
MonetaryAmountFactory<T>	setCurrency(CurrencyUnit currency)
MonetaryAmountFactory<T>	setCurrency(String currencyCode)
MonetaryAmountFactory<T>	setNumber(double number) Creates a new instance of Monetary, using the default MonetaryContext.
MonetaryAmountFactory<T>	setNumber(long number)
MonetaryAmountFactory<T>	setNumber(Number number)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.money.MonetaryAmountFactory

getAmountType, getMaxNumber, getMinNumber

Constructor Detail

AbstractAmountFactory

public AbstractAmountFactory()

Method Detail

create

public T create()

Creates a new instance of MonetaryAmount, using the default MonetaryContext.

Specified by:

create in interface MonetaryAmountFactory<T extends MonetaryAmount>

Returns:

a MonetaryAmount combining the numeric value and currency unit.

Throws:

ArithmeticException - If the number exceeds the capabilities of the default MonetaryContext used.

create

protected abstract T create(Number number,
                            CurrencyUnit currency,
                            MonetaryContext monetaryContext)

loadDefaultMonetaryContext

protected abstract MonetaryContext loadDefaultMonetaryContext()

loadMaxMonetaryContext

protected abstract MonetaryContext loadMaxMonetaryContext()

setCurrency

public MonetaryAmountFactory<T> setCurrency(CurrencyUnit currency)

Specified by:

setCurrency in interface MonetaryAmountFactory<T extends MonetaryAmount>

setNumber

public MonetaryAmountFactory<T> setNumber(Number number)

Specified by:

setNumber in interface MonetaryAmountFactory<T extends MonetaryAmount>

setCurrency

public MonetaryAmountFactory<T> setCurrency(String currencyCode)

Specified by:

setCurrency in interface MonetaryAmountFactory<T extends MonetaryAmount>

setNumber

public MonetaryAmountFactory<T> setNumber(double number)

Creates a new instance of Monetary, using the default MonetaryContext.

Specified by:

setNumber in interface MonetaryAmountFactory<T extends MonetaryAmount>

Parameters:

number - numeric value.

Returns:

a Money combining the numeric value and currency unit.

Throws:

ArithmeticException - If the number exceeds the capabilities of the default MonetaryContext used.

UnknownCurrencyException - if the currency code can not be resolved to CurrencyUnit.

setNumber

public MonetaryAmountFactory<T> setNumber(long number)

Specified by:

setNumber in interface MonetaryAmountFactory<T extends MonetaryAmount>

setContext

public MonetaryAmountFactory<T> setContext(MonetaryContext monetaryContext)

Specified by:

setContext in interface MonetaryAmountFactory<T extends MonetaryAmount>

getDefaultMonetaryContext

public MonetaryContext getDefaultMonetaryContext()

Returns the default MonetaryContext used, when no MonetaryContext is provided.

Specified by:

getDefaultMonetaryContext in interface MonetaryAmountFactory<T extends MonetaryAmount>

Returns:

the default MonetaryContext, never null.

getMaximalMonetaryContext

public MonetaryContext getMaximalMonetaryContext()

Returns the maximal MonetaryContext supported.

Specified by:

getMaximalMonetaryContext in interface MonetaryAmountFactory<T extends MonetaryAmount>

Returns:

the maximal MonetaryContext, never null.

setAmount

public MonetaryAmountFactory<T> setAmount(MonetaryAmount smount)

Converts (if necessary) the given MonetaryAmount to a new MonetaryAmount instance, hereby supporting the MonetaryContext given.

Specified by:

setAmount in interface MonetaryAmountFactory<T extends MonetaryAmount>

Parameters:

smount - the amount to be converted, if necessary.

Returns:

an according Money instance.

getBigDecimal

@Deprecated
protected static BigDecimal getBigDecimal(Number num)

Deprecated. will be removed in next release

Creates a BigDecimal from the given Number doing the valid conversion depending the type given.

Parameters:

num - the number type

Returns:

the corresponding BigDecimal