FxRateCalculatorBuilder (ObjectLab Kit 1.4.8 API)

java.lang.Object
- net.objectlab.kit.fxcalc.FxRateCalculatorBuilder

public class FxRateCalculatorBuilder
extends Object

Parameters for an immutable FxRateCalculator. The FX Calculator requires Base Rates to return rates, inverse rates or cross rates. There are 3 ways to import rates via the FxRateCalculatorBuilder.

addRateSnapshot(FxRate rate): add the rate to an internal map per CurrencyPair, an immutable map will be given to the Calculator so the bases rates will NOT change.
ratesSnapshot(Collection<FxRate> rates): add a collection of rates to an internal map per CurrencyPair, an immutable map will be given to the Calculator so the bases rates will NOT change.
baseFxRateProvider(BaseFxRateProvider) You then control when the Base Rates change, the Calculator will call the required CurrencyPair you either every time or once (if cacheBaseRates is true).

 final FxRateCalculatorBuilder builder = new FxRateCalculatorBuilder() //
        .addRateSnapshot(new FxRateImpl(CurrencyPair.of("EUR", "USD"), null, true, BigDecimalUtil.bd("1.6"), BigDecimalUtil.bd("1.61")))//
        .addRateSnapshot(new FxRateImpl(CurrencyPair.of("GBP", "CHF"), null, true, BigDecimalUtil.bd("2.1702"), BigDecimalUtil.bd("2.1707")))//
        .addRateSnapshot(new FxRateImpl(CurrencyPair.of("EUR", "GBP"), null, true, BigDecimalUtil.bd("0.7374"), BigDecimalUtil.bd("0.7379")))//
        .orderedCurrenciesForCross(Lists.newArrayList("GBP", "USD")) // Use GBP as the first cross ccy, if that doesn't work use USD
        .majorCurrencyRanking(StandardMajorCurrencyRanking.getdefault())
        .precisionForFxRate(6)
        .precisionForInverseFxRate(12)
        .currencyProvider(new JdkCurrencyProvider()) // use the JDK currency
        .cacheResults(true) // only calculate a cross Fx once, cache for subsequent requests
        .cacheBaseRates(true); // if a BaseFxRateRateProvider is used, cache the rates instead of calling again for same currency pair

Author:: Benoit Xhenseval

Constructor Summary

Constructors
Constructor and Description

FxRateCalculatorBuilder()

Constructors
Constructor and Description
`FxRateCalculatorBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FxRateCalculatorBuilder`	`addRateSnapshot(FxRate rate)` Snapshot of FxRate, typically they are the Base FX Rates (e.g.
`FxRateCalculatorBuilder`	`askRounding(int askRounding)` Rounding for BID calculations.
`FxRateCalculatorBuilder`	`baseFxRateProvider(BaseFxRateProvider baseFxRateProvider)` If it is important for you to get the latest rates every time, you can provide a rate provider using this interface.
`FxRateCalculatorBuilder`	`bidRounding(int bidRounding)` Rounding for BID calculations.
`FxRateCalculatorBuilder`	`cacheBaseRates(boolean cacheBaseRates)` If using the baseFxRateProvider, should the rate be cached in the calculator, defaulted to true.
`FxRateCalculatorBuilder`	`cacheResults(boolean cacheResults)` Once a new rate has been calculated, should it be cached for any further request?
`void`	`checkValid()` Check if the builder is valid i.e.
`FxRateCalculatorBuilder`	`currencyProvider(CurrencyProvider currencyProvider)` The interface to determine Currency details.
`int`	`getAskRounding()`
`BaseFxRateProvider`	`getBaseFxRateProvider()`
`int`	`getBidRounding()`
`CurrencyProvider`	`getCurrencyProvider()`
`MajorCurrencyRanking`	`getMajorCurrencyRanking()`
`List<String>`	`getOrderedCurrenciesForCross()`
`int`	`getPrecisionForFxRate()`
`int`	`getPrecisionForInverseFxRate()`
`Map<CurrencyPair,FxRate>`	`getRatesSnapshot()`
`boolean`	`isCacheBaseRates()`
`boolean`	`isCacheResults()`
`FxRateCalculatorBuilder`	`majorCurrencyRanking(MajorCurrencyRanking majorCurrencyRanking)` The interface to determine which currency is major, defaults to StandardMajorCurrencyRanking.
`FxRateCalculatorBuilder`	`orderedCurrenciesForCross(List<String> orderedCurrenciesForCross)` If the rate required from the calculator is not immediately available, use a cross currency to calculate it; this gives you the opportunity to select which currencies to use in which order.
`FxRateCalculatorBuilder`	`precisionForFxRate(int precisionForFxRate)` Number of decimal places to use on a rate, defaulted to 6.
`FxRateCalculatorBuilder`	`precisionForInverseFxRate(int precisionForInverseFxRate)` Number of decimal places to use for a calculation involving an inversed rate, defaulted to 12
`FxRateCalculatorBuilder`	`ratesSnapshot(Collection<FxRate> rates)` Snapshot of FxRate, typically they are the Base FX Rates (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FxRateCalculatorBuilder
```
public FxRateCalculatorBuilder()
```
- Method Detail
  - checkValid
```
public void checkValid()
```
    Check if the builder is valid i.e. * precisions greater than 1 * ratesSnapshot not empty or a BaseFxRateProvider was provided
    
    Throws:
    
    IllegalArgumentException - if the validation fails.
  - baseFxRateProvider
```
public FxRateCalculatorBuilder baseFxRateProvider(BaseFxRateProvider baseFxRateProvider)
```
    If it is important for you to get the latest rates every time, you can provide a rate provider using this interface.
  - getMajorCurrencyRanking
```
public MajorCurrencyRanking getMajorCurrencyRanking()
```
  - getOrderedCurrenciesForCross
```
public List<String> getOrderedCurrenciesForCross()
```
  - getPrecisionForFxRate
```
public int getPrecisionForFxRate()
```
  - getPrecisionForInverseFxRate
```
public int getPrecisionForInverseFxRate()
```
  - isCacheResults
```
public boolean isCacheResults()
```
  - isCacheBaseRates
```
public boolean isCacheBaseRates()
```
  - getBaseFxRateProvider
```
public BaseFxRateProvider getBaseFxRateProvider()
```
  - cacheResults
```
public FxRateCalculatorBuilder cacheResults(boolean cacheResults)
```
    Once a new rate has been calculated, should it be cached for any further request?
    
    Returns:
    
    the builder
  - cacheBaseRates
```
public FxRateCalculatorBuilder cacheBaseRates(boolean cacheBaseRates)
```
    If using the baseFxRateProvider, should the rate be cached in the calculator, defaulted to true.
    
    Returns:
    
    the builder
  - precisionForFxRate
```
public FxRateCalculatorBuilder precisionForFxRate(int precisionForFxRate)
```
    Number of decimal places to use on a rate, defaulted to 6.
    
    Returns:
    
    the builder
  - precisionForInverseFxRate
```
public FxRateCalculatorBuilder precisionForInverseFxRate(int precisionForInverseFxRate)
```
    Number of decimal places to use for a calculation involving an inversed rate, defaulted to 12
    
    Returns:
    
    the builder
  - bidRounding
```
public FxRateCalculatorBuilder bidRounding(int bidRounding)
```
    Rounding for BID calculations.
    
    Returns:
    
    the builder
  - askRounding
```
public FxRateCalculatorBuilder askRounding(int askRounding)
```
    Rounding for BID calculations.
    
    Returns:
    
    the builder
  - orderedCurrenciesForCross
```
public FxRateCalculatorBuilder orderedCurrenciesForCross(List<String> orderedCurrenciesForCross)
```
    If the rate required from the calculator is not immediately available, use a cross currency to calculate it; this gives you the opportunity to select which currencies to use in which order. Defaulted to USD and then EUR.
    
    Returns:
    
    the builder
  - majorCurrencyRanking
```
public FxRateCalculatorBuilder majorCurrencyRanking(MajorCurrencyRanking majorCurrencyRanking)
```
    The interface to determine which currency is major, defaults to StandardMajorCurrencyRanking.
    
    Returns:
    
    the builder
  - currencyProvider
```
public FxRateCalculatorBuilder currencyProvider(CurrencyProvider currencyProvider)
```
    The interface to determine Currency details.
    
    Returns:
    
    the builder
  - ratesSnapshot
```
public FxRateCalculatorBuilder ratesSnapshot(Collection<FxRate> rates)
```
    Snapshot of FxRate, typically they are the Base FX Rates (e.g. vs USD)
    
    Returns:
    
    the builder
  - addRateSnapshot
```
public FxRateCalculatorBuilder addRateSnapshot(FxRate rate)
```
    Snapshot of FxRate, typically they are the Base FX Rates (e.g. vs USD).
    
    Returns:
    
    the builder
  - getRatesSnapshot
```
public Map<CurrencyPair,FxRate> getRatesSnapshot()
```
  - getBidRounding
```
public int getBidRounding()
```
  - getAskRounding
```
public int getAskRounding()
```
  - getCurrencyProvider
```
public CurrencyProvider getCurrencyProvider()
```

Class FxRateCalculatorBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FxRateCalculatorBuilder

Method Detail

checkValid

baseFxRateProvider

getMajorCurrencyRanking

getOrderedCurrenciesForCross

getPrecisionForFxRate

getPrecisionForInverseFxRate

isCacheResults

isCacheBaseRates

getBaseFxRateProvider

cacheResults

cacheBaseRates

precisionForFxRate

precisionForInverseFxRate

bidRounding

askRounding

orderedCurrenciesForCross

majorCurrencyRanking

currencyProvider

ratesSnapshot

addRateSnapshot

getRatesSnapshot

getBidRounding

getAskRounding

getCurrencyProvider