Module java.money

Package javax.money.convert

Class ConversionQueryBuilder

java.lang.Object

javax.money.AbstractContextBuilder<B,C>

javax.money.AbstractQueryBuilder<ConversionQueryBuilder,ConversionQuery>

javax.money.convert.ConversionQueryBuilder

public final class ConversionQueryBuilder
extends AbstractQueryBuilder<ConversionQueryBuilder,ConversionQuery>

Builder class for creating new instances of ConversionQuery adding detailed information about a CurrencyConversion instance.

Note this class is NOT thread-safe.

See Also:

MonetaryConversions.getConversion(ConversionQuery)

Method Summary

Modifier and Type	Method	Description
ConversionQuery	build()	Creates a new instance of ConversionQuery.
static ConversionQueryBuilder	of()	Creates a new ConversionQueryBuilder instance.
static ConversionQueryBuilder	of(ConversionQuery query)	Creates a new ConversionQueryBuilder instance.
ConversionQueryBuilder	setBaseCurrency(java.lang.String currencyCode)	Sets the base currency.
ConversionQueryBuilder	setBaseCurrency(CurrencyUnit currency)	Sets the base currency.
ConversionQueryBuilder	setRateTypes(java.util.Set<RateType> rateTypes)	Set the providers to be considered.
ConversionQueryBuilder	setRateTypes(RateType... rateTypes)	Set the providers to be considered.
ConversionQueryBuilder	setTermCurrency(java.lang.String currencyCode)	Sets the term currency.
ConversionQueryBuilder	setTermCurrency(CurrencyUnit currency)	Sets the term currency.

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

setRateTypes

public ConversionQueryBuilder setRateTypes(RateType... rateTypes)

Set the providers to be considered. If not set explicitly the default ISO currencies as returned by Currency is used.

Parameters:

rateTypes - the rate types to use, not null.

Returns:

the query for chaining.

setRateTypes

public ConversionQueryBuilder setRateTypes(java.util.Set<RateType> rateTypes)

Set the providers to be considered. If not set explicitly the default ISO currencies as returned by Currency is used.

Parameters:

rateTypes - the rate types to use, not null.

Returns:

the query for chaining.

setBaseCurrency

public ConversionQueryBuilder setBaseCurrency(CurrencyUnit currency)

Sets the base currency.

Parameters:

currency - the base currency

Returns:

the query for chaining.

setBaseCurrency

public ConversionQueryBuilder setBaseCurrency(java.lang.String currencyCode)

Sets the base currency.

Parameters:

currencyCode - the currency code, resolvable through .MonetaryCurrencies#getCurrency(String, String...), not null.

Returns:

the query for chaining.

setTermCurrency

public ConversionQueryBuilder setTermCurrency(CurrencyUnit currency)

Sets the term currency.

Parameters:

currency - the base currency

Returns:

the query for chaining.

setTermCurrency

public ConversionQueryBuilder setTermCurrency(java.lang.String currencyCode)

Sets the term currency.

Parameters:

currencyCode - the currency code, resolvable through .MonetaryCurrencies#getCurrency(String, String...), not null.

Returns:

the query for chaining.

build

public ConversionQuery build()

Creates a new instance of ConversionQuery.

Specified by:

build in class AbstractQueryBuilder<ConversionQueryBuilder,ConversionQuery>

Returns:

a new ConversionQuery instance.

of

public static ConversionQueryBuilder of()

Creates a new ConversionQueryBuilder instance.

Returns:

a new ConversionQueryBuilder instance, never null.

of

public static ConversionQueryBuilder of(ConversionQuery query)

Creates a new ConversionQueryBuilder instance.

Parameters:

query - the ConversionQuery instance to be used as a template.

Returns:

a new ConversionQueryBuilder instance, never null.