javax.money

Interface MonetaryAmountFactory<T extends MonetaryAmount>

public interface MonetaryAmountFactory<T extends MonetaryAmount>

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

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

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

Method Summary

Modifier and Type	Method and Description
T	create() Creates a new instance of MonetaryAmount, using the current data set on this factory.
Class<? extends MonetaryAmount>	getAmountType() Access the MonetaryAmount implementation type.
MonetaryContext	getDefaultMonetaryContext() Returns the default MonetaryContext used, when no MonetaryContext is provided.
default MonetaryContext	getMaximalMonetaryContext() Returns the maximal MonetaryContext supported, for requests that exceed these maximal capabilities, an ArithmeticException must be thrown.
NumberValue	getMaxNumber() Get the maximum possible number that this type can represent.
NumberValue	getMinNumber() Get the minimum possible number that this type can represent.
default MonetaryAmountFactory<T>	setAmount(MonetaryAmount amount) Uses an arbitrary MonetaryAmount to initialize this factory.
MonetaryAmountFactory<T>	setContext(MonetaryContext monetaryContext) Sets the MonetaryContext to be used.
MonetaryAmountFactory<T>	setCurrency(CurrencyUnit currency) Sets the CurrencyUnit to be used.
default MonetaryAmountFactory<T>	setCurrency(String currencyCode) Sets the CurrencyUnit to be used.
MonetaryAmountFactory<T>	setNumber(double number) Sets the number to be used.
MonetaryAmountFactory<T>	setNumber(long number) Sets the number to be used.
MonetaryAmountFactory<T>	setNumber(Number number) Sets the number to be used.

Method Detail

getAmountType

Class<? extends MonetaryAmount> getAmountType()

Access the MonetaryAmount implementation type.

Returns:

the MonetaryAmount implementation type, never null.

setCurrency

default MonetaryAmountFactory<T> setCurrency(String currencyCode)

Sets the CurrencyUnit to be used.

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.

setCurrency

MonetaryAmountFactory<T> setCurrency(CurrencyUnit currency)

Sets the CurrencyUnit to be used.

Parameters:

currency - the CurrencyUnit to be used, not null

Returns:

This factory instance, for chaining.

setNumber

MonetaryAmountFactory<T> setNumber(double number)

Sets the number to be used.

Parameters:

number - the number to be used

Returns:

This factory instance, for chaining.

setNumber

MonetaryAmountFactory<T> setNumber(long number)

Sets the number to be used.

Parameters:

number - the number to be used

Returns:

This factory instance, for chaining.

setNumber

MonetaryAmountFactory<T> setNumber(Number number)

Sets the number to be used.

Parameters:

number - the number to be used, not null.

Returns:

This factory instance, for chaining.

getMaxNumber

NumberValue getMaxNumber()

Get the maximum possible number that this type can represent. If the numeric model has no limitations on the numeric range, null should be returned. If MonetaryContext.getPrecision() returns a value > 0 this method is required to provide a maximal amount.

Returns:

the maximum possible number, or null.

getMinNumber

NumberValue getMinNumber()

Get the minimum possible number that this type can represent. If the numeric model has no limitations on the numeric range, null should be returned. If MonetaryContext.getPrecision() returns a value > 0 this method is required to provide a maximal amount.

Returns:

the minimum possible number, or null.

setContext

MonetaryAmountFactory<T> setContext(MonetaryContext monetaryContext)

Sets the MonetaryContext to be used.

Parameters:

monetaryContext - the MonetaryContext to be used, not null.

Returns:

This factory instance, for chaining.

Throws:

MonetaryException - when the MonetaryContext given exceeds the capabilities supported by this factory type.

See Also:

getMaximalMonetaryContext()

setAmount

default MonetaryAmountFactory<T> setAmount(MonetaryAmount amount)

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

• CurrencyUnit,
• Number value,
• MonetaryContext.

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.

create

T create()

Creates a new instance of MonetaryAmount, using the current data set on this factory.

Returns:

the corresponding MonetaryAmount.

See Also:

getAmountType()

getDefaultMonetaryContext

MonetaryContext getDefaultMonetaryContext()

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

The default context is not allowed to exceed the capabilities of the maximal MonetaryContext supported.

Returns:

the default MonetaryContext, never null.

See Also:

getMaximalMonetaryContext()

getMaximalMonetaryContext

default MonetaryContext getMaximalMonetaryContext()

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

Returns:

the maximal MonetaryContext supported, never null