org.javamoney.moneta.spi.base

Class BaseMonetaryRoundingsSingletonSpi

java.lang.Object

org.javamoney.moneta.spi.base.BaseMonetaryRoundingsSingletonSpi

All Implemented Interfaces:

MonetaryRoundingsSingletonSpi

public abstract class BaseMonetaryRoundingsSingletonSpi
extends Object
implements MonetaryRoundingsSingletonSpi

This class models the accessor for rounding instances, modeled as MonetaryOperator. This class is thread-safe.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
BaseMonetaryRoundingsSingletonSpi()

Method Summary

Modifier and Type	Method and Description
MonetaryRounding	getRounding(CurrencyUnit currencyUnit, String... providers) Access a MonetaryRounding for rounding MonetaryAmount instances given a currency.
MonetaryRounding	getRounding(RoundingQuery query) Query a specific rounding with the given query.
MonetaryRounding	getRounding(String roundingName, String... providers) Access a MonetaryRounding using the rounding name.
boolean	isRoundingAvailable(CurrencyUnit currencyUnit, String... providers) Checks if a MonetaryRounding is available given a CurrencyUnit.
boolean	isRoundingAvailable(RoundingQuery query) Checks if any MonetaryRounding is matching the given query.
boolean	isRoundingAvailable(String roundingId, String... providers) Checks if a MonetaryRounding is available given a roundingId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.money.spi.MonetaryRoundingsSingletonSpi

getDefaultProviderChain, getDefaultRounding, getProviderNames, getRoundingNames, getRoundings

Constructor Detail

BaseMonetaryRoundingsSingletonSpi

public BaseMonetaryRoundingsSingletonSpi()

Method Detail

getRounding

public MonetaryRounding getRounding(CurrencyUnit currencyUnit,
                                    String... providers)

Access a MonetaryRounding for rounding MonetaryAmount instances given a currency.

Specified by:

getRounding in interface MonetaryRoundingsSingletonSpi

Parameters:

currencyUnit - The currency, which determines the required precision. As RoundingMode, by default, RoundingMode.HALF_UP is sued.

providers - the optional provider list and ordering to be used

Returns:

a new instance MonetaryOperator implementing the rounding, never null.

Throws:

MonetaryException - if no such rounding could be provided.

getRounding

public MonetaryRounding getRounding(String roundingName,
                                    String... providers)

Access a MonetaryRounding using the rounding name.

Specified by:

getRounding in interface MonetaryRoundingsSingletonSpi

Parameters:

roundingName - The rounding name, not null.

providers - the optional provider list and ordering to be used

Returns:

the corresponding MonetaryOperator implementing the rounding, never null.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

getRounding

public MonetaryRounding getRounding(RoundingQuery query)

Query a specific rounding with the given query. If multiple roundings match the query the first one is selected, since the query allows to determine the providers and their ordering by setting AbstractQuery.getProviderNames().

Specified by:

getRounding in interface MonetaryRoundingsSingletonSpi

Parameters:

query - the rounding query, not null.

Returns:

the rounding found, or null, if no rounding matches the query.

isRoundingAvailable

public boolean isRoundingAvailable(RoundingQuery query)

Checks if any MonetaryRounding is matching the given query.

Specified by:

isRoundingAvailable in interface MonetaryRoundingsSingletonSpi

Parameters:

query - the rounding query, not null.

Returns:

true, if at least one rounding matches the query.

isRoundingAvailable

public boolean isRoundingAvailable(String roundingId,
                                   String... providers)

Checks if a MonetaryRounding is available given a roundingId.

Specified by:

isRoundingAvailable in interface MonetaryRoundingsSingletonSpi

Parameters:

roundingId - The rounding identifier.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

true, if a corresponding MonetaryRounding is available.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.

isRoundingAvailable

public boolean isRoundingAvailable(CurrencyUnit currencyUnit,
                                   String... providers)

Checks if a MonetaryRounding is available given a CurrencyUnit.

Specified by:

isRoundingAvailable in interface MonetaryRoundingsSingletonSpi

Parameters:

currencyUnit - The currency, which determines the required precision. As RoundingMode, by default, RoundingMode.HALF_UP is used.

providers - the providers and ordering to be used. By default providers and ordering as defined in #getDefaultProviders is used.

Returns:

true, if a corresponding MonetaryRounding is available.

Throws:

IllegalArgumentException - if no such rounding is registered using a RoundingProviderSpi instance.