JSR 354 (Money and Currency API) 1.1 · javax.money.RoundingQuery

Query for accessing instances of javax.money.MonetaryRounding. In general it is determined by the implementation, what roundings are provided. Nevertheless the following queries must be supported:

Accessing roundings using rounding names and/or regular expressions.
Accessing mathematical rounding by setting a scale and (optionally) a java.math.MathContext as additional generic attribute.
Accessing default roundings for a javax.money.CurrencyUnit. This method should return the most appropriate rounding for a currency. If no currency specific rounding is available, it should return a rounding with scale==currency .getDefaultFractionUnits(), java.math.RoundingMode = RoundingMode.HALF_EVEN.

All other roundings including cash rounding and historical roundings are optional.

This class is immutable, thread-safe and serializable.

Field Summary

Modifier and Type	Field and Description
pack-priv static final String	KEY_QUERY_ROUNDING_NAME Attribute key used for the rounding name attribute.
pack-priv static final String	KEY_QUERY_SCALE Attribute key used for the scale attribute.
private static final long	serialVersionUID Hides javax.money.AbstractQuery.serialVersionUID.

Inherited from javax.money.AbstractQuery:: KEY_QUERY_PROVIDERS KEY_QUERY_TARGET_TYPE KEY_QUERY_TIMESTAMP

Access	Constructor and Description
pack-priv	RoundingQuery(RoundingQueryBuilder the corresponding builder, not null. builder) Constructor, used from the `javax.money.RoundingQueryBuilder`.

Method Summary

Modifier and Type	Method and Description
public CurrencyUnit	Returns: the CurrencyUnit, or null. getCurrency() Implements javax.money.CurrencySupplier.getCurrency. Sets the target CurrencyUnit.
public String	Returns: the rounding id or null. getRoundingName() Gets the target rounding name.
public Integer	Returns: the target scale or null. getScale() Gets the target scale.
public RoundingQueryBuilder	Returns: a new `javax.money.RoundingQueryBuilder` instance, never null. toBuilder() Creates a new builder instances, initialized with the data from this one.

Inherited from javax.money.AbstractQuery:: getProviderNames getTargetType

Field Detail

KEY_QUERY_ROUNDING_NAME	back to summary
pack-priv static final String KEY_QUERY_ROUNDING_NAME Attribute key used for the rounding name attribute.

KEY_QUERY_SCALE	back to summary
pack-priv static final String KEY_QUERY_SCALE Attribute key used for the scale attribute.

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.money.AbstractQuery.serialVersionUID.

Constructor Detail

RoundingQuery back to summary

RoundingQuery	back to summary
pack-priv RoundingQuery(RoundingQueryBuilder builder) Constructor, used from the `javax.money.RoundingQueryBuilder`. Parameters builder:RoundingQueryBuilder the corresponding builder, not null.

pack-priv RoundingQuery(RoundingQueryBuilder builder)

Constructor, used from the javax.money.RoundingQueryBuilder.

Parameters

builder:RoundingQueryBuilder: the corresponding builder, not null.

Method Detail

getCurrency	back to summary
public CurrencyUnit getCurrency() Implements javax.money.CurrencySupplier.getCurrency. Sets the target CurrencyUnit. Typically this determines all other properties, such as scale and the concrete rounding algorithm. With rounding names, depending on the implementation, additional sub-selections are possible. Similarly additional attributes can be used to select special rounding instances, e.g. for cash rounding. Returns:CurrencyUnit the CurrencyUnit, or null. Annotations @Override

getCurrency

back to summary

public CurrencyUnit getCurrency()

Implements javax.money.CurrencySupplier.getCurrency.

Sets the target CurrencyUnit. Typically this determines all other properties, such as scale and the concrete rounding algorithm. With rounding names, depending on the implementation, additional sub-selections are possible. Similarly additional attributes can be used to select special rounding instances, e.g. for cash rounding.

Returns:CurrencyUnit

the CurrencyUnit, or null.

Annotations

@Override

getRoundingName back to summary

getRoundingName	back to summary
public String getRoundingName() Gets the target rounding name. This method allows to access the `javax.money.MonetaryRounding` instances by passing a name, which most of the time identifies a certain rounding instance. Each entry is first matched as name on equality. If no instance with such a name exists, the value passed is interpreted as a regular expression to lookup roundings. Returns:String the rounding id or null.

public String getRoundingName()

Gets the target rounding name. This method allows to access the javax.money.MonetaryRounding instances by passing a name, which most of the time identifies a certain rounding instance. Each entry is first matched as name on equality. If no instance with such a name exists, the value passed is interpreted as a regular expression to lookup roundings.

Returns:String: the rounding id or null.

getScale	back to summary
public Integer getScale() Gets the target scale. This allows to define the scale required. If not specified as additional attribute, by default, RoundingMode.HALF_EVEN is used hereby. Returns:Integer the target scale or null.

getScale

back to summary

public Integer getScale()

Gets the target scale. This allows to define the scale required. If not specified as additional attribute, by default, RoundingMode.HALF_EVEN is used hereby.

Returns:Integer: the target scale or null.

toBuilder back to summary

toBuilder	back to summary
public RoundingQueryBuilder toBuilder() Creates a new builder instances, initialized with the data from this one. Returns:RoundingQueryBuilder a new `javax.money.RoundingQueryBuilder` instance, never null.

public RoundingQueryBuilder toBuilder()

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

Returns:RoundingQueryBuilder: a new javax.money.RoundingQueryBuilder instance, never null.

public final Class RoundingQuery

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail