org.javamoney.moneta.spi.base

Class BaseMonetaryAmountFactory<T extends MonetaryAmount>

java.lang.Object

org.javamoney.moneta.spi.base.BaseMonetaryAmountFactory<T>

All Implemented Interfaces:

MonetaryAmountFactory<T>

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

Factory for MonetaryAmount instances for a given type. It can be accessed, by

• calling MonetaryAmount.getFactory(), returning a BaseMonetaryAmountFactory creating amounts of the same implementation type, which also provided the factory instance.
• calling Monetary.getAmountFactory(Class) accessing a BaseMonetaryAmountFactory for a concrete type Class<T>.
• calling Monetary.getDefaultAmountFactory() accessing a default BaseMonetaryAmountFactory.

Implementations of this interface allow to get MonetaryAmount instances providing different data as required:

• the CurrencyUnit, or the corresponding currency code (must be solvable by Monetary).
• the number part
• the MonetaryContext
• by passing any MonetaryAmount instance, it is possible to convert an arbitrary amount implementation to the implementation provided by this factory. If the current factory cannot support the precision/scale as required by the current NumberValue a MonetaryException must be thrown.

If not defined a default MonetaryContext is used, which can also be configured by adding configuration to a file /javamoney.properties to the classpath. Hereby the entries. e.g. for a class MyMoney should start with a.b.MyMoney.ctx. The entries valid must be documented on the according implementation class, where the following entries are defined for all implementation types (example below given for a class a.b.MyMoney:

• a.b.MyMoney.ctx.precision to define the maximal supported precision.
• a.b.MyMoney.ctx.maxScale to define the maximal supported scale.
• a.b.MyMoney.ctx.fixedScale to define the scale to be fixed (constant).

Implementation specification

Instances of this interface are not required to be thread-safe!

Version:

0.6.1

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
BaseMonetaryAmountFactory()

Method Summary

Modifier and Type	Method and Description
MonetaryContext	getMaximalMonetaryContext() Returns the maximal MonetaryContext supported, for requests that exceed these maximal capabilities, an ArithmeticException must be thrown.
MonetaryAmountFactory<T>	setAmount(MonetaryAmount amount) Uses an arbitrary MonetaryAmount to initialize this factory.
MonetaryAmountFactory<T>	setCurrency(String currencyCode) Sets the CurrencyUnit to be used.

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

create, getAmountType, getDefaultMonetaryContext, getMaxNumber, getMinNumber, setContext, setCurrency, setNumber, setNumber, setNumber

Constructor Detail

BaseMonetaryAmountFactory

public BaseMonetaryAmountFactory()

Method Detail

setCurrency

public MonetaryAmountFactory<T> setCurrency(String currencyCode)

Sets the CurrencyUnit to be used.

Specified by:

setCurrency in interface MonetaryAmountFactory<T extends MonetaryAmount>

Parameters:

currencyCode - the currencyCode of the currency to be used, not null. The currency code will be resolved using Monetary.getCurrency(String, String...).

Returns:

This factory instance, for chaining.

Throws:

UnknownCurrencyException - if the currencyCode is not resolvable.

UnknownCurrencyException - if the currencyCode is not resolvable.

setAmount

public MonetaryAmountFactory<T> setAmount(MonetaryAmount amount)

Uses an arbitrary MonetaryAmount to initialize this factory. Properties reused are:

• CurrencyUnit,
• Number value,
• MonetaryContext.

Specified by:

setAmount in interface MonetaryAmountFactory<T extends MonetaryAmount>

Parameters:

amount - the amount to be used, not null.

Returns:

this factory instance, for chaining.

Throws:

MonetaryException - when the MonetaryContext implied by amount.getContext() exceeds the capabilities supported by this factory type.

getMaximalMonetaryContext

public MonetaryContext getMaximalMonetaryContext()

Returns the maximal MonetaryContext supported, for requests that exceed these maximal capabilities, an ArithmeticException must be thrown.

Specified by:

getMaximalMonetaryContext in interface MonetaryAmountFactory<T extends MonetaryAmount>

Returns:

the maximal MonetaryContext supported, never null