Top Description Fields Constructors Methods
javax.money

public final Class CurrencyQuery

extends AbstractQuery
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@SuppressWarnings:unchecked
Imports
java.io.Serializable, java.util.Collection, .Collections, .Locale
This class models a query for accessing instances of CurrencyUnit. It provides information such as The effective attributes supported are only determined by the implementations of .CurrencyProviderSpi.

This class is immutable, serializable and thread-safe.

Author
Anatole Tresch

Field Summary

Modifier and TypeField and Description
pack-priv static final String
KEY_QUERY_COUNTRIES

Key for storing a countries to be queried.

pack-priv static final String
KEY_QUERY_CURRENCY_CODES

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

pack-priv static final String
KEY_QUERY_NUMERIC_CODES

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

private static final long
serialVersionUID

Hides javax.money.AbstractQuery.serialVersionUID.

Inherited from javax.money.AbstractQuery:
KEY_QUERY_PROVIDERSKEY_QUERY_TARGET_TYPEKEY_QUERY_TIMESTAMP

Constructor Summary

AccessConstructor and Description
pack-priv
CurrencyQuery(CurrencyQueryBuilder
the corresponding javax.money.CurrencyQueryBuilder, not null.
builder)

Constructor, used from the Builder.

Method Summary

Modifier and TypeMethod and Description
public Collection<Locale>

Returns:

the target locales, never null.
getCountries()

Returns the target locales.

public Collection<String>

Returns:

the target currency codes or the regular expression, never null.
getCurrencyCodes()

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

public Collection<Integer>

Returns:

the target numeric codes, never null.
getNumericCodes()

Gets the numeric codes.

public CurrencyQueryBuilder

Returns:

a new MonetaryAmountFactoryQueryBuilder instance, never null.
toBuilder()

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

Inherited from javax.money.AbstractQuery:
getProviderNamesgetTargetType

Field Detail

KEY_QUERY_COUNTRIESback to summary
pack-priv static final String KEY_QUERY_COUNTRIES

Key for storing a countries to be queried.

KEY_QUERY_CURRENCY_CODESback to summary
pack-priv static final String KEY_QUERY_CURRENCY_CODES

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

KEY_QUERY_NUMERIC_CODESback to summary
pack-priv static final String KEY_QUERY_NUMERIC_CODES

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.money.AbstractQuery.serialVersionUID.

Constructor Detail

CurrencyQueryback to summary
pack-priv CurrencyQuery(CurrencyQueryBuilder builder)

Constructor, used from the Builder.

Parameters
builder:CurrencyQueryBuilder

the corresponding javax.money.CurrencyQueryBuilder, not null.

Method Detail

getCountriesback to summary
public Collection<Locale> getCountries()

Returns the target locales.

Returns:Collection<Locale>

the target locales, never null.

getCurrencyCodesback to summary
public Collection<String> getCurrencyCodes()

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

Returns:Collection<String>

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

getNumericCodesback to summary
public Collection<Integer> getNumericCodes()

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

Returns:Collection<Integer>

the target numeric codes, never null.

toBuilderback to summary
public CurrencyQueryBuilder toBuilder()

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

Returns:CurrencyQueryBuilder

a new MonetaryAmountFactoryQueryBuilder instance, never null.