Module java.money

Package javax.money.spi

Interface MonetaryAmountsSingletonSpi

public interface MonetaryAmountsSingletonSpi

SPI (core) for the backing implementation of the Monetary singleton. It should load and manage (including contextual behavior), if needed) the different registered MonetaryAmountFactory instances.

Author:

Anatole Tresch

Method Summary

Modifier and Type	Method	Description
default java.util.Collection<MonetaryAmountFactory<?>>	getAmountFactories()	Get the currently registered MonetaryAmount implementation classes.
<T extends MonetaryAmount> MonetaryAmountFactory<T>	getAmountFactory(java.lang.Class<T> amountType)	Access the MonetaryAmountFactory for the given amountType .
java.util.Collection<java.lang.Class<? extends MonetaryAmount>>	getAmountTypes()	Get the currently registered MonetaryAmount implementation types.
default MonetaryAmountFactory<?>	getDefaultAmountFactory()	Access the default MonetaryAmountFactory.
java.lang.Class<? extends MonetaryAmount>	getDefaultAmountType()	Access the default MonetaryAmount implementation type.

Method Details

getAmountFactory

<T extends MonetaryAmount> MonetaryAmountFactory<T> getAmountFactory(java.lang.Class<T> amountType)

Access the MonetaryAmountFactory for the given amountType .

Parameters:

amountType - the MonetaryAmount implementation type, targeted by the factory.

Returns:

the MonetaryAmountFactory, or null, if no such MonetaryAmountFactory is available in the current context.

getDefaultAmountType

java.lang.Class<? extends MonetaryAmount> getDefaultAmountType()

Access the default MonetaryAmount implementation type.

Returns:

a the default MonetaryAmount type corresponding, never null.

Throws:

MonetaryException - if no MonetaryAmountFactoryProviderSpi is available, or no MonetaryAmountFactoryProviderSpi targeting the configured default MonetaryAmount type.

See Also:

Monetary.getDefaultAmountType()

getAmountTypes

java.util.Collection<java.lang.Class<? extends MonetaryAmount>> getAmountTypes()

Get the currently registered MonetaryAmount implementation types.

Returns:

the Set if registered MonetaryAmount implementations, never null.

getDefaultAmountFactory

default MonetaryAmountFactory<?> getDefaultAmountFactory()

Access the default MonetaryAmountFactory.

Returns:

a the default MonetaryAmount type corresponding, never null.

Throws:

MonetaryException - if no MonetaryAmountFactoryProviderSpi is available, or no MonetaryAmountFactoryProviderSpi targeting the configured default MonetaryAmount type.

See Also:

Monetary.getDefaultAmountType()

getAmountFactories

default java.util.Collection<MonetaryAmountFactory<?>> getAmountFactories()

Get the currently registered MonetaryAmount implementation classes.

Returns:

the Set if registered MonetaryAmount implementations, never null.