Module java.money

Package javax.money

Class RoundingContext

java.lang.Object

javax.money.AbstractContext

javax.money.RoundingContext

All Implemented Interfaces:

java.io.Serializable, CurrencySupplier

public final class RoundingContext
extends AbstractContext
implements java.io.Serializable, CurrencySupplier

This class models the spec/configuration for a rounding, modeled as MonetaryRounding in a platform independent way. Each RoundingContext instance hereby has a roundingId, which links to the RoundingProviderSpi that must of the according rounding instance. The default roundingId is default.

A RoundingContext can take up arbitrary attributes that must be documented by the RoundingProviderSpi implementations.

Examples for such additional attributes are RoundingMode, MathContext, additional regional information, e.g. if a given rounding is targeting cash rounding.

This class is immutable, serializable, thread-safe.

Author:

Anatole Tresch

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.money.AbstractContext

KEY_PROVIDER

Method Summary

Modifier and Type	Method	Description
CurrencyUnit	getCurrency()	Get the basic CurrencyUnit, which is based for this rounding type.
java.lang.String	getRoundingName()	Get the (custom) rounding id.
RoundingContextBuilder	toBuilder()	Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows to change the values and of another CurrencyContext instance.

Methods inherited from class javax.money.AbstractContext

equals, get, get, getBoolean, getDouble, getFloat, getInt, getKeys, getLong, getProviderName, getText, getType, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getRoundingName

public java.lang.String getRoundingName()

Get the (custom) rounding id.

Returns:

the rounding id, or null.

getCurrency

public CurrencyUnit getCurrency()

Get the basic CurrencyUnit, which is based for this rounding type.

Specified by:

getCurrency in interface CurrencySupplier

Returns:

the target CurrencyUnit, or null.

toBuilder

public RoundingContextBuilder toBuilder()

Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows to change the values and of another CurrencyContext instance.

Returns:

a new Builder instance, preinitialized with the values from this instance.