org.javamoney.moneta

Class DefaultExchangeRate.Builder

java.lang.Object

org.javamoney.moneta.DefaultExchangeRate.Builder

Enclosing class:

DefaultExchangeRate

public static class DefaultExchangeRate.Builder
extends Object

Builder for creating new instances of ExchangeRate. Note that instances of this class are not thread-safe.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
Builder(javax.money.convert.ConversionContext context) Sets the exchange rate type
Builder(javax.money.convert.ExchangeRate rate) Sets the exchange rate type
Builder(String provider, javax.money.convert.RateType rateType) Sets the exchange rate type

Method Summary

Modifier and Type	Method and Description
DefaultExchangeRate	build() Builds a new instance of ExchangeRate.
DefaultExchangeRate.Builder	setBase(javax.money.CurrencyUnit base) Sets the base CurrencyUnit
DefaultExchangeRate.Builder	setContext(javax.money.convert.ConversionContext conversionContext) Sets the provider to be applied.
DefaultExchangeRate.Builder	setFactor(javax.money.NumberValue factor) Sets the conversion factor, as the factor base * factor = target.
DefaultExchangeRate.Builder	setRate(javax.money.convert.ExchangeRate rate) Initialize the DefaultExchangeRate.Builder with an ExchangeRate.
DefaultExchangeRate.Builder	setRateChain(javax.money.convert.ExchangeRate... exchangeRates) Sets the ExchangeRate chain.
DefaultExchangeRate.Builder	setRateChain(List<javax.money.convert.ExchangeRate> exchangeRates) Sets the ExchangeRate chain.
DefaultExchangeRate.Builder	setTerm(javax.money.CurrencyUnit term) Sets the terminating (target) CurrencyUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String provider,
               javax.money.convert.RateType rateType)

Sets the exchange rate type

Parameters:

rateType - the RateType contained

Builder

public Builder(javax.money.convert.ConversionContext context)

Sets the exchange rate type

Parameters:

context - the ConversionContext to be applied

Builder

public Builder(javax.money.convert.ExchangeRate rate)

Sets the exchange rate type

Parameters:

rate - the ExchangeRate to be applied

Method Detail

setBase

public DefaultExchangeRate.Builder setBase(javax.money.CurrencyUnit base)

Sets the base CurrencyUnit

Parameters:

base - to base (source) CurrencyUnit to be applied

Returns:

the builder instance

setTerm

public DefaultExchangeRate.Builder setTerm(javax.money.CurrencyUnit term)

Sets the terminating (target) CurrencyUnit

Parameters:

term - to terminating CurrencyUnit to be applied

Returns:

the builder instance

setRateChain

public DefaultExchangeRate.Builder setRateChain(javax.money.convert.ExchangeRate... exchangeRates)

Sets the ExchangeRate chain.

Parameters:

exchangeRates - the ExchangeRate chain to be applied

Returns:

the builder instance

setRateChain

public DefaultExchangeRate.Builder setRateChain(List<javax.money.convert.ExchangeRate> exchangeRates)

Sets the ExchangeRate chain.

Parameters:

exchangeRates - the ExchangeRate chain to be applied

Returns:

the builder instance

setFactor

public DefaultExchangeRate.Builder setFactor(javax.money.NumberValue factor)

Sets the conversion factor, as the factor base * factor = target.

Parameters:

factor - the factor.

Returns:

The builder instance.

setContext

public DefaultExchangeRate.Builder setContext(javax.money.convert.ConversionContext conversionContext)

Sets the provider to be applied.

Parameters:

conversionContext - the ConversionContext, not null.

Returns:

The builder.

build

public DefaultExchangeRate build()

Builds a new instance of ExchangeRate.

Returns:

a new instance of ExchangeRate.

Throws:

IllegalArgumentException - if the rate could not be built.

setRate

public DefaultExchangeRate.Builder setRate(javax.money.convert.ExchangeRate rate)

Initialize the DefaultExchangeRate.Builder with an ExchangeRate. This is useful for creating a new rate, reusing some properties from an existing one.

Parameters:

rate - the base rate

Returns:

the Builder, for chaining.