Module java.money

Package javax.money

Class MonetaryContext

java.lang.Object

javax.money.AbstractContext

javax.money.MonetaryContext

All Implemented Interfaces:

Serializable

public final class MonetaryContext
extends AbstractContext
implements Serializable

This class models the meta data (mostly the numeric capabilities) of a MonetaryAmount in a platform independent way. It provides information about

• the maximal precision supported (0, for unlimited precision).
• the minimum scale (>=0)
• the maximal scale (>= -1, -1 for unlimited scale).
• the numeric representation class.
• any other attributes, identified by the attribute type, e.g. RoundingMode.

This class is immutable, serializable and thread-safe.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	AMOUNT_TYPE	Constant that defines under which key the amount type is stored in the context map.
private static final String	FIXED_SCALE	Key name for the fixed scale.
private static final String	MAX_SCALE	Key name for the max scale.
private static final String	PRECISION	Key name for the precision.
private static final long	serialVersionUID

Fields inherited from class javax.money.AbstractContext

data, KEY_PROVIDER

Constructor Summary

Constructors

Constructor	Description
MonetaryContext(MonetaryContextBuilder builder)	Constructor, used from the Builder.

Method Summary

Modifier and Type	Method	Description
static MonetaryContext	from(MonetaryAmountFactoryQuery monetaryAmountFactoryQuery, Class<? extends MonetaryAmount> amountClass)	This method allows to easily of a new MonetaryContext instance from a given .MonetaryAmountFactoryQuery.
static MonetaryContext	from(MonetaryContext monetaryContext, Class<? extends MonetaryAmount> amountClass)	Creates a new invalid input: '{@link /*missing*/}'MonetaryContext).
Class<? extends MonetaryAmount>	getAmountType()	Get the MonetaryAmount implementation class.
int	getMaxScale()	Get the maximal scale supported, always >= -1.
int	getPrecision()	Returns the precision setting.
boolean	isFixedScale()	Allows to check if minScale == maxScale.
MonetaryContextBuilder	toBuilder()	Creates a new builder instances, initialized with the data from this one.

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

AMOUNT_TYPE

static final String AMOUNT_TYPE

Constant that defines under which key the amount type is stored in the context map.

See Also:

• Constant Field Values

PRECISION

private static final String PRECISION

Key name for the precision.

See Also:

• Constant Field Values

FIXED_SCALE

private static final String FIXED_SCALE

Key name for the fixed scale.

See Also:

• Constant Field Values

MAX_SCALE

private static final String MAX_SCALE

Key name for the max scale.

See Also:

• Constant Field Values

Constructor Details

MonetaryContext

MonetaryContext(MonetaryContextBuilder builder)

Constructor, used from the Builder.

Parameters:

builder - the corresponding builder, not null.

Method Details

getPrecision

public int getPrecision()

Returns the precision setting. This value is always non-negative.

Returns:

an int which is the value of the precision setting

isFixedScale

public boolean isFixedScale()

Allows to check if minScale == maxScale.

Returns:

true if minScale == maxScale.

getMaxScale

public int getMaxScale()

Get the maximal scale supported, always >= -1. Fixed scaled numbers will have scale==maxScale for all values. -1 declares the maximal scale to be unlimited.

Returns:

the maximal scale supported, always >= -1

getAmountType

public Class<? extends MonetaryAmount> getAmountType()

Get the MonetaryAmount implementation class.

Returns:

the implementation class of the containing amount instance, never null.

See Also:

• MonetaryAmount.getContext()

from

public static MonetaryContext from(MonetaryAmountFactoryQuery monetaryAmountFactoryQuery,
 Class<? extends MonetaryAmount> amountClass)

This method allows to easily of a new MonetaryContext instance from a given .MonetaryAmountFactoryQuery.

Parameters:

monetaryAmountFactoryQuery - the monetary amount factory query, not null.

amountClass - the targeted implementation type.

Returns:

a new corresponding MonetaryContext instance.

from

public static MonetaryContext from(MonetaryContext monetaryContext,
 Class<? extends MonetaryAmount> amountClass)

Creates a new invalid input: '{@link /*missing*/}'MonetaryContext).

Parameters:

monetaryContext - the base context, not null.

amountClass - the target amount class.

Returns:

a new corresponding MonetaryContext instance.

toBuilder

public MonetaryContextBuilder toBuilder()

Creates a new builder instances, initialized with the data from this one.

Returns:

a new MonetaryContextBuilder instance, never null.