Module java.money

Package javax.money

Class CurrencyQuery

java.lang.Object

javax.money.AbstractContext

javax.money.AbstractQuery

javax.money.CurrencyQuery

All Implemented Interfaces:

java.io.Serializable

public final class CurrencyQuery
extends AbstractQuery
implements java.io.Serializable

This class models a query for accessing instances of CurrencyUnit. It provides information such as

• the providers that may provide CurrencyUnit instances
• any other attributes, identified by the attribute type, e.g. regions, tenants, a target timestamp / temporal unit, when the CurrencyUnit instances should be valid, etc.

The effective attributes supported are only determined by the implementations of .CurrencyProviderSpi.

This class is immutable, serializable and thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	KEY_QUERY_COUNTRIES	Key for storing a countries to be queried.
(package private) static java.lang.String	KEY_QUERY_CURRENCY_CODES	Key for storing a target literal currency codes to be queried.
(package private) static java.lang.String	KEY_QUERY_NUMERIC_CODES	Key for storing a target numeric currency codes to be queried.
private static long	serialVersionUID

Fields inherited from class javax.money.AbstractQuery

KEY_QUERY_PROVIDERS, KEY_QUERY_TARGET_TYPE, KEY_QUERY_TIMESTAMP

Fields inherited from class javax.money.AbstractContext

data, KEY_PROVIDER

Constructor Summary

Constructors

Constructor	Description
CurrencyQuery(CurrencyQueryBuilder builder)	Constructor, used from the Builder.

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.util.Locale>	getCountries()	Returns the target locales.
java.util.Collection<java.lang.String>	getCurrencyCodes()	Gets the currency codes, or the regular expression to select codes.
java.util.Collection<java.lang.Integer>	getNumericCodes()	Gets the numeric codes.
CurrencyQueryBuilder	toBuilder()	Creates a new builder instances, initialized with the data from this one.

Methods inherited from class javax.money.AbstractQuery

getProviderNames, getTargetType

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 Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_QUERY_COUNTRIES

static final java.lang.String KEY_QUERY_COUNTRIES

Key for storing a countries to be queried.

See Also:

Constant Field Values

KEY_QUERY_CURRENCY_CODES

static final java.lang.String KEY_QUERY_CURRENCY_CODES

Key for storing a target literal currency codes to be queried.

See Also:

Constant Field Values

KEY_QUERY_NUMERIC_CODES

static final java.lang.String KEY_QUERY_NUMERIC_CODES

Key for storing a target numeric currency codes to be queried.

See Also:

Constant Field Values

Constructor Detail

CurrencyQuery

CurrencyQuery(CurrencyQueryBuilder builder)

Constructor, used from the Builder.

Parameters:

builder - the corresponding CurrencyQueryBuilder, not null.

Method Detail

getCountries

public java.util.Collection<java.util.Locale> getCountries()

Returns the target locales.

Returns:

the target locales, never null.

getCurrencyCodes

public java.util.Collection<java.lang.String> getCurrencyCodes()

Gets the currency codes, or the regular expression to select codes.

Returns:

the target currency codes or the regular expression, never null.

getNumericCodes

public java.util.Collection<java.lang.Integer> getNumericCodes()

Gets the numeric codes. Setting it to -1 search for currencies that have no numeric code.

Returns:

the target numeric codes, never null.

toBuilder

public CurrencyQueryBuilder toBuilder()

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

Returns:

a new MonetaryAmountFactoryQueryBuilder instance, never null.