Module java.money

Package javax.money

Class RoundingContext

java.lang.Object

javax.money.AbstractContext

javax.money.RoundingContext

All Implemented Interfaces:

Serializable, CurrencySupplier

public final class RoundingContext
extends AbstractContext
implements 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.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	KEY_ROUNDING_NAME	Attribute key used for the rounding name.
private static final long	serialVersionUID

Fields inherited from class javax.money.AbstractContext

data, KEY_PROVIDER

Constructor Summary

Constructors

Constructor	Description
RoundingContext(RoundingContextBuilder builder)	Constructor, used from the RoundingContextBuilder.

Method Summary

Modifier and Type	Method	Description
CurrencyUnit	getCurrency()	Get the basic CurrencyUnit, which is based for this rounding type.
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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

KEY_ROUNDING_NAME

static final String KEY_ROUNDING_NAME

Attribute key used for the rounding name.

See Also:

• Constant Field Values

Constructor Details

RoundingContext

RoundingContext(RoundingContextBuilder builder)

Constructor, used from the RoundingContextBuilder.

Parameters:

builder - the corresponding builder, not null.

Method Details

getRoundingName

public 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.