javax.money.spi

Interface MonetaryAmountFactoryProviderSpi<T extends MonetaryAmount>

Type Parameters:

T - the concrete amount type.

public interface MonetaryAmountFactoryProviderSpi<T extends MonetaryAmount>

SPI (core): Implementations of this interface are used by the MonetaryAmountsSingletonSpi to evaluate the correct MonetaryAmountFactory instances.

Author:

Anatole Tresch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy Determines how the factory should be considered when querying for matching implementation types calling Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery) .

Method Summary

Modifier and Type	Method and Description
MonetaryAmountFactory<T>	createMonetaryAmountFactory() Access a MonetaryAmountFactory given the required context.
Class<T>	getAmountType() Get the concrete amount type created by MonetaryAmountFactory instances provided.
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.
default MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy	getQueryInclusionPolicy() Method that determines if this factory should be considered for general evaluation of matching MonetaryAmount implementation types when calling Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery).

Method Detail

getQueryInclusionPolicy

default MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy getQueryInclusionPolicy()

Method that determines if this factory should be considered for general evaluation of matching MonetaryAmount implementation types when calling Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery).

Returns:

true to include this factory into the evaluation.

See Also:

Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery)

getAmountType

Class<T> getAmountType()

Get the concrete amount type created by MonetaryAmountFactory instances provided.

Returns:

the concrete amount type created, never null.

createMonetaryAmountFactory

MonetaryAmountFactory<T> createMonetaryAmountFactory()

Access a MonetaryAmountFactory given the required context.

Returns:

the corresponding MonetaryAmountFactory, or null.

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