org.javamoney.moneta.convert

Class ExchangeRateBuilder

java.lang.Object

org.javamoney.moneta.convert.ExchangeRateBuilder

public class ExchangeRateBuilder
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
ExchangeRateBuilder(ConversionContext context) Sets the exchange rate type
ExchangeRateBuilder(ExchangeRate rate) Sets the exchange rate type
ExchangeRateBuilder(String provider, RateType rateType) Sets the exchange rate type

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExchangeRateBuilder

public ExchangeRateBuilder(String provider,
                           RateType rateType)

Sets the exchange rate type

Parameters:

rateType - the RateType contained

ExchangeRateBuilder

public ExchangeRateBuilder(ConversionContext context)

Sets the exchange rate type

Parameters:

context - the ConversionContext to be applied

ExchangeRateBuilder

public ExchangeRateBuilder(ExchangeRate rate)

Sets the exchange rate type

Parameters:

rate - the ExchangeRate to be applied

Method Detail

setBase

public ExchangeRateBuilder setBase(CurrencyUnit base)

Sets the base CurrencyUnit

Parameters:

base - to base (source) CurrencyUnit to be applied

Returns:

the builder instance

setTerm

public ExchangeRateBuilder setTerm(CurrencyUnit term)

Sets the terminating (target) CurrencyUnit

Parameters:

term - to terminating CurrencyUnit to be applied

Returns:

the builder instance

setRateChain

public ExchangeRateBuilder setRateChain(ExchangeRate... exchangeRates)

Sets the ExchangeRate chain.

Parameters:

exchangeRates - the ExchangeRate chain to be applied

Returns:

the builder instance

setRateChain

public ExchangeRateBuilder setRateChain(List<ExchangeRate> exchangeRates)

Sets the ExchangeRate chain.

Parameters:

exchangeRates - the ExchangeRate chain to be applied

Returns:

the builder instance

setFactor

public ExchangeRateBuilder setFactor(NumberValue factor)

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

Parameters:

factor - the factor.

Returns:

The builder instance.

setContext

public ExchangeRateBuilder setContext(ConversionContext conversionContext)

Sets the provider to be applied.

Parameters:

conversionContext - the ConversionContext, not null.

Returns:

The builder.

build

public ExchangeRate build()

Builds a new instance of ExchangeRate.

Returns:

a new instance of ExchangeRate.

Throws:

IllegalArgumentException - if the rate could not be built.

setRate

public ExchangeRateBuilder setRate(ExchangeRate rate)

Initialize the ExchangeRateBuilder 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.

toString

public String toString()

Overrides:

toString in class Object