JSR 354 (Money and Currency API) 1.1 · javax.money.MonetaryAmountFactory

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<T>.
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!

Method Summary

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

Method Detail

create back to summary

create	back to summary
public T create() Creates a new instance of `MonetaryAmount`, using the current data set on this factory. Returns:T the corresponding `MonetaryAmount`. See Also `getAmountType()`

public T create()

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

Returns:T: the corresponding MonetaryAmount.
See Also: getAmountType()

getAmountType back to summary

getAmountType	back to summary
public Class<? extends MonetaryAmount> getAmountType() Access the `MonetaryAmount` implementation type. Returns:Class<? extends MonetaryAmount> the `MonetaryAmount` implementation type, never `null`.

public Class<? extends MonetaryAmount> getAmountType()

Access the MonetaryAmount implementation type.

Returns:Class<? extends MonetaryAmount>: the MonetaryAmount implementation type, never null.

getDefaultMonetaryContext back to summary

getDefaultMonetaryContext	back to summary
public 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:MonetaryContext the default `MonetaryContext`, never `null`. See Also `getMaximalMonetaryContext()`

public 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:MonetaryContext: the default MonetaryContext, never null.
See Also: getMaximalMonetaryContext()

getMaximalMonetaryContext back to summary

getMaximalMonetaryContext	back to summary
public default MonetaryContext getMaximalMonetaryContext() Returns the maximal `MonetaryContext` supported, for requests that exceed these maximal capabilities, an `ArithmeticException` must be thrown. Returns:MonetaryContext the maximal `MonetaryContext` supported, never `null`

public default MonetaryContext getMaximalMonetaryContext()

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

Returns:MonetaryContext: the maximal MonetaryContext supported, never null

getMaxNumber back to summary

getMaxNumber	back to summary
public 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:NumberValue the maximum possible number, or null.

public 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:NumberValue: the maximum possible number, or null.

getMinNumber back to summary

getMinNumber	back to summary
public 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:NumberValue the minimum possible number, or null.

public 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:NumberValue: the minimum possible number, or null.

setAmount back to summary

setAmount	back to summary
public default MonetaryAmountFactory<T> setAmount(MonetaryAmount amount) Uses an arbitrary `MonetaryAmount` to initialize this factory. Properties reused are: CurrencyUnit, Number value, MonetaryContext. Parameters amount:MonetaryAmount the amount to be used, not `null`. Returns:MonetaryAmountFactory<T> this factory instance, for chaining. Exceptions MonetaryException: when the `MonetaryContext` implied by `amount.getContext()` exceeds the capabilities supported by this factory type.

public default MonetaryAmountFactory<T> setAmount(MonetaryAmount amount)

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

CurrencyUnit,
Number value,
MonetaryContext.

Parameters

amount:MonetaryAmount: the amount to be used, not null.

Returns:MonetaryAmountFactory<T>

this factory instance, for chaining.

Exceptions

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

setContext back to summary

setContext	back to summary
public MonetaryAmountFactory<T> setContext(MonetaryContext monetaryContext) Sets the `MonetaryContext` to be used. Parameters monetaryContext:MonetaryContext the `MonetaryContext` to be used, not `null`. Returns:MonetaryAmountFactory<T> This factory instance, for chaining. Exceptions MonetaryException: when the `MonetaryContext` given exceeds the capabilities supported by this factory type. See Also `getMaximalMonetaryContext()`

public MonetaryAmountFactory<T> setContext(MonetaryContext monetaryContext)

Sets the MonetaryContext to be used.

Parameters

monetaryContext:MonetaryContext: the MonetaryContext to be used, not null.

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

Exceptions

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

See Also

getMaximalMonetaryContext()

setCurrency back to summary

setCurrency	back to summary
public default MonetaryAmountFactory<T> setCurrency(String currencyCode) Sets the `CurrencyUnit` to be used. Parameters currencyCode:String the currencyCode of the currency to be used, not `null`. The currency code will be resolved using `Monetary#getCurrency(String, String...)`. Returns:MonetaryAmountFactory<T> This factory instance, for chaining. Exceptions UnknownCurrencyException: if the `currencyCode` is not resolvable.

public default MonetaryAmountFactory<T> setCurrency(String currencyCode)

Sets the CurrencyUnit to be used.

Parameters

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

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

Exceptions

UnknownCurrencyException:: if the currencyCode is not resolvable.

setCurrency back to summary

setCurrency	back to summary
public MonetaryAmountFactory<T> setCurrency(CurrencyUnit currency) Sets the `CurrencyUnit` to be used. Parameters currency:CurrencyUnit the `CurrencyUnit` to be used, not `null` Returns:MonetaryAmountFactory<T> This factory instance, for chaining.

public MonetaryAmountFactory<T> setCurrency(CurrencyUnit currency)

Sets the CurrencyUnit to be used.

Parameters

currency:CurrencyUnit: the CurrencyUnit to be used, not null

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

setNumber	back to summary
public MonetaryAmountFactory<T> setNumber(double number) Sets the number to be used. Parameters number:double the number to be used Returns:MonetaryAmountFactory<T> This factory instance, for chaining.

setNumber

back to summary

public MonetaryAmountFactory<T> setNumber(double number)

Sets the number to be used.

Parameters

number:double: the number to be used

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

setNumber	back to summary
public MonetaryAmountFactory<T> setNumber(long number) Sets the number to be used. Parameters number:long the number to be used Returns:MonetaryAmountFactory<T> This factory instance, for chaining.

setNumber

back to summary

public MonetaryAmountFactory<T> setNumber(long number)

Sets the number to be used.

Parameters

number:long: the number to be used

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

setNumber back to summary

setNumber	back to summary
public MonetaryAmountFactory<T> setNumber(Number number) Sets the number to be used. Parameters number:Number the number to be used, not `null`. Returns:MonetaryAmountFactory<T> This factory instance, for chaining.

public MonetaryAmountFactory<T> setNumber(Number number)

Sets the number to be used.

Parameters

number:Number: the number to be used, not null.

Returns:MonetaryAmountFactory<T>

This factory instance, for chaining.

public Interface MonetaryAmountFactory<T extends javax.money.MonetaryAmount>

Implementation specification

Method Summary

Method Detail