Module java.money

Package javax.money

Class CurrencyQueryBuilder

java.lang.Object

javax.money.AbstractContextBuilder<B,C>

javax.money.AbstractQueryBuilder<CurrencyQueryBuilder,CurrencyQuery>

javax.money.CurrencyQueryBuilder

public final class CurrencyQueryBuilder
extends AbstractQueryBuilder<CurrencyQueryBuilder,CurrencyQuery>

Builder for queries for accessing CurrencyUnit instances. If not properties are set the query should returns the default currencies. Similarly if no provider is set explicitly the default ISO currencies as returned by Currency should be returned.

Note this class is NOT thread-safe.

Method Summary

Modifier and Type	Method	Description
CurrencyQuery	build()	Creates a new instance of CurrencyQuery.
static CurrencyQueryBuilder	of()	Creates a new instance of CurrencyQueryBuilder.
static CurrencyQueryBuilder	of(CurrencyQuery currencyQuery)	Creates a new instance of CurrencyQueryBuilder.
CurrencyQueryBuilder	setCountries(java.util.Locale... countries)	Sets the country for which currencies should be requested.
CurrencyQueryBuilder	setCurrencyCodes(java.lang.String... codes)	Sets the currency code, or the regular expression to select codes.
CurrencyQueryBuilder	setNumericCodes(int... codes)	Set the numeric code.

Methods inherited from class javax.money.AbstractQueryBuilder

set, setProviderName, setProviderNames, setProviderNames, setTargetType

Methods inherited from class javax.money.AbstractContextBuilder

importContext, importContext, removeAttributes, set, set, set, set, set, set, set, set, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

setCountries

public CurrencyQueryBuilder setCountries(java.util.Locale... countries)

Sets the country for which currencies should be requested.

Parameters:

countries - The ISO countries.

Returns:

the query for chaining.

setCurrencyCodes

public CurrencyQueryBuilder setCurrencyCodes(java.lang.String... codes)

Sets the currency code, or the regular expression to select codes.

Parameters:

codes - the currency codes or code expressions, not null.

Returns:

the query for chaining.

setNumericCodes

public CurrencyQueryBuilder setNumericCodes(int... codes)

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

Parameters:

codes - the numeric codes.

Returns:

the query for chaining.

build

public CurrencyQuery build()

Creates a new instance of CurrencyQuery.

Specified by:

build in class AbstractQueryBuilder<CurrencyQueryBuilder,CurrencyQuery>

Returns:

a new CurrencyQuery instance, never null.

of

public static CurrencyQueryBuilder of()

Creates a new instance of CurrencyQueryBuilder.

Returns:

a new CurrencyQueryBuilder instance, never null.

of

public static CurrencyQueryBuilder of(CurrencyQuery currencyQuery)

Creates a new instance of CurrencyQueryBuilder.

Parameters:

currencyQuery - CurrencyQuery used for initializing this builder.

Returns:

a new CurrencyQueryBuilder instance, never null.