Top Description Constructors Methods
javax.money.convert

public final Class ConversionQueryBuilder

extends AbstractQueryBuilder<ConversionQueryBuilder, ConversionQuery>
Class Inheritance
Imports
javax.money.AbstractQueryBuilder, .CurrencyUnit, .Monetary, java.util.Arrays, .HashSet, .Set
Builder class for creating new instances of javax.money.convert.ConversionQuery adding detailed information about a javax.money.convert.CurrencyConversion instance.

Note this class is NOT thread-safe.

See Also
javax.money.convert.MonetaryConversions#getConversion(ConversionQuery)

Constructor Summary

AccessConstructor and Description
private
ConversionQueryBuilder()

Method Summary

Modifier and TypeMethod and Description
public ConversionQuery

Returns:

a new ConversionQuery instance.
build()

Implements abstract javax.money.AbstractQueryBuilder.build.

Creates a new instance of ConversionQuery.
public static ConversionQueryBuilder

Returns:

a new javax.money.convert.ConversionQueryBuilder instance, never null.
of()

Creates a new javax.money.convert.ConversionQueryBuilder instance.

public static ConversionQueryBuilder

Returns:

a new javax.money.convert.ConversionQueryBuilder instance, never null.
of(ConversionQuery
the javax.money.convert.ConversionQuery instance to be used as a template.
query)

Creates a new javax.money.convert.ConversionQueryBuilder instance.

public ConversionQueryBuilder

Returns:

the query for chaining.
setBaseCurrency(CurrencyUnit
the base currency
currency)

Sets the base currency.

public ConversionQueryBuilder

Returns:

the query for chaining.
setBaseCurrency(String
the currency code, resolvable through .MonetaryCurrencies#getCurrency(String, String...), not null.
currencyCode)

Sets the base currency.

public ConversionQueryBuilder

Returns:

the query for chaining.
setRateTypes(RateType...
the rate types to use, not null.
rateTypes)

Set the providers to be considered.

public ConversionQueryBuilder

Returns:

the query for chaining.
setRateTypes(Set<RateType>
the rate types to use, not null.
rateTypes)

Set the providers to be considered.

public ConversionQueryBuilder

Returns:

the query for chaining.
setTermCurrency(CurrencyUnit
the base currency
currency)

Sets the term currency.

public ConversionQueryBuilder

Returns:

the query for chaining.
setTermCurrency(String
the currency code, resolvable through .MonetaryCurrencies#getCurrency(String, String...), not null.
currencyCode)

Sets the term currency.

Inherited from javax.money.AbstractQueryBuilder:
setsetProviderNamesetProviderNamessetProviderNamessetTargetType

Constructor Detail

ConversionQueryBuilderback to summary
private ConversionQueryBuilder()

Method Detail

buildback to summary
public ConversionQuery build()

Implements abstract javax.money.AbstractQueryBuilder.build.

Creates a new instance of ConversionQuery.

Returns:ConversionQuery

a new ConversionQuery instance.

Annotations
@Override
ofback to summary
public static ConversionQueryBuilder of()

Creates a new javax.money.convert.ConversionQueryBuilder instance.

Returns:ConversionQueryBuilder

a new javax.money.convert.ConversionQueryBuilder instance, never null.

ofback to summary
public static ConversionQueryBuilder of(ConversionQuery query)

Creates a new javax.money.convert.ConversionQueryBuilder instance.

Parameters
query:ConversionQuery

the javax.money.convert.ConversionQuery instance to be used as a template.

Returns:ConversionQueryBuilder

a new javax.money.convert.ConversionQueryBuilder instance, never null.

setBaseCurrencyback to summary
public ConversionQueryBuilder setBaseCurrency(CurrencyUnit currency)

Sets the base currency.

Parameters
currency:CurrencyUnit

the base currency

Returns:ConversionQueryBuilder

the query for chaining.

setBaseCurrencyback to summary
public ConversionQueryBuilder setBaseCurrency(String currencyCode)

Sets the base currency.

Parameters
currencyCode:String

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

Returns:ConversionQueryBuilder

the query for chaining.

setRateTypesback to summary
public ConversionQueryBuilder setRateTypes(RateType... rateTypes)

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

Parameters
rateTypes:RateType[]

the rate types to use, not null.

Returns:ConversionQueryBuilder

the query for chaining.

setRateTypesback to summary
public ConversionQueryBuilder setRateTypes(Set<RateType> rateTypes)

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

Parameters
rateTypes:Set<RateType>

the rate types to use, not null.

Returns:ConversionQueryBuilder

the query for chaining.

setTermCurrencyback to summary
public ConversionQueryBuilder setTermCurrency(CurrencyUnit currency)

Sets the term currency.

Parameters
currency:CurrencyUnit

the base currency

Returns:ConversionQueryBuilder

the query for chaining.

setTermCurrencyback to summary
public ConversionQueryBuilder setTermCurrency(String currencyCode)

Sets the term currency.

Parameters
currencyCode:String

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

Returns:ConversionQueryBuilder

the query for chaining.