FxRateImpl (ObjectLab Kit 1.4.8 API)

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

All Implemented Interfaces:

FxRate
```
public class FxRateImpl
extends Object
implements FxRate
```
Represents an immutable FxRate.

Author:

Benoit Xhenseval

Constructor Summary

Constructors
Constructor and Description
`FxRateImpl(CurrencyPair currencyPair, String crossCcy, boolean marketConvention, BigDecimal bid, BigDecimal ask, CurrencyProvider currencyProvider)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CurrencyAmount`	`convertAmountUsingBidOrAsk(CurrencyAmount originalAmount)` Given a monetary amount in the original currency, calculate the resulting amount in the other currency, using BID or ASK depending on the originalAmount.currency.
`CurrencyAmount`	`convertAmountUsingMid(CurrencyAmount originalAmount)` Given a monetary amount in the original currency, calculate the resulting amount in the other currency, using MID rate.
`FxRate`	`createInverse()` Create the FX Rate for ccy2 / ccy1, return a new FxRate; the inverse of bid / ask are swapped around.
`FxRate`	`createInverse(int precision)` Create the FX Rate for ccy2 / ccy1, return a new FxRate with given precision; the inverse of bid / ask are swapped around.
`BigDecimal`	`getAsk()` The price at which the 'quoter' is willing to buy ccy1 and sell ccy2.
`BigDecimal`	`getAskInMarketConvention()` Useful for human readable display, returns the same value as Ask if FxRate is in market convention otherwise 1/bid.
`BigDecimal`	`getBid()` The price at which the 'quoter' is willing to sell ccy1 and buy ccy2.
`BigDecimal`	`getBidInMarketConvention()` Useful for human readable display, returns the same value as Bid if FxRate is in market convention otherwise 1/ask.
`Optional<String>`	`getCrossCcy()` This FxRate might come from a combination of 2 rates through a cross currency, if it is the case, return the cross currency.
`CurrencyPair`	`getCurrencyPair()` The CurrencyPair as in Ccy1/Ccy2 where the Bid will be the price for selling ccy1 and buying ccy2.
`String`	`getDescription()` Nice human readable description of the FX Rate, useful reminder.
`BigDecimal`	`getMid()` Mid = (bid + ask) / 2
`BigDecimal`	`getMidInMarketConvention()` Mid = (bid + ask) / 2
`CurrencyAmount`	`getPaymentAmountForBuying(CurrencyAmount amountToBuy)` Calculates the amount to pay given an amount to buy, e.g.
`CurrencyAmount`	`getReceiptAmountForSelling(CurrencyAmount amountToSell)` Calculates the amount the seller would receive given an amount to sell, e.g.
`boolean`	`isMarketConvention()` true if the CurrencyPair follows market convention, e.g.
`String`	`toString()`

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

- Constructor Detail
  - FxRateImpl
```
public FxRateImpl(CurrencyPair currencyPair,
                  String crossCcy,
                  boolean marketConvention,
                  BigDecimal bid,
                  BigDecimal ask,
                  CurrencyProvider currencyProvider)
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Nice human readable description of the FX Rate, useful reminder.
```
 CAD.SGD Mkt Convention:true
 Quoter buys  CAD and sells SGD at 1.1279
 Quoter sells CAD and buys  SGD at 1.1289
 
```
    Specified by:
    
    getDescription in interface FxRate
  - createInverse
```
public FxRate createInverse()
```
    Description copied from interface: FxRate
    
    Create the FX Rate for ccy2 / ccy1, return a new FxRate; the inverse of bid / ask are swapped around.
    
    Specified by:
    
    createInverse in interface FxRate
  - createInverse
```
public FxRate createInverse(int precision)
```
    Description copied from interface: FxRate
    
    Create the FX Rate for ccy2 / ccy1, return a new FxRate with given precision; the inverse of bid / ask are swapped around.
    
    Specified by:
    
    createInverse in interface FxRate
  - getBid
```
public BigDecimal getBid()
```
    Description copied from interface: FxRate
    
    The price at which the 'quoter' is willing to sell ccy1 and buy ccy2.
    
    Specified by:
    
    getBid in interface FxRate
  - getAsk
```
public BigDecimal getAsk()
```
    Description copied from interface: FxRate
    
    The price at which the 'quoter' is willing to buy ccy1 and sell ccy2.
    
    Specified by:
    
    getAsk in interface FxRate
  - getCurrencyPair
```
public CurrencyPair getCurrencyPair()
```
    Description copied from interface: FxRate
    
    The CurrencyPair as in Ccy1/Ccy2 where the Bid will be the price for selling ccy1 and buying ccy2.
    
    Specified by:
    
    getCurrencyPair in interface FxRate
  - getCrossCcy
```
public Optional<String> getCrossCcy()
```
    Description copied from interface: FxRate
    
    This FxRate might come from a combination of 2 rates through a cross currency, if it is the case, return the cross currency.
    
    Specified by:
    
    getCrossCcy in interface FxRate
  - isMarketConvention
```
public boolean isMarketConvention()
```
    Description copied from interface: FxRate
    
    true if the CurrencyPair follows market convention, e.g. EUR/USD and not USD/EUR (but it gets more complicated for other cross-currencies, eg CHF/JPY?)
    
    Specified by:
    
    isMarketConvention in interface FxRate
  - getMid
```
public BigDecimal getMid()
```
    Description copied from interface: FxRate
    
    Mid = (bid + ask) / 2
    
    Specified by:
    
    getMid in interface FxRate
  - getBidInMarketConvention
```
public BigDecimal getBidInMarketConvention()
```
    Description copied from interface: FxRate
    
    Useful for human readable display, returns the same value as Bid if FxRate is in market convention otherwise 1/ask.
    
    Specified by:
    
    getBidInMarketConvention in interface FxRate
  - getMidInMarketConvention
```
public BigDecimal getMidInMarketConvention()
```
    Description copied from interface: FxRate
    
    Mid = (bid + ask) / 2
    
    Specified by:
    
    getMidInMarketConvention in interface FxRate
  - getAskInMarketConvention
```
public BigDecimal getAskInMarketConvention()
```
    Description copied from interface: FxRate
    
    Useful for human readable display, returns the same value as Ask if FxRate is in market convention otherwise 1/bid.
    
    Specified by:
    
    getAskInMarketConvention in interface FxRate
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - convertAmountUsingMid
```
public CurrencyAmount convertAmountUsingMid(CurrencyAmount originalAmount)
```
    Description copied from interface: FxRate
    
    Given a monetary amount in the original currency, calculate the resulting amount in the other currency, using MID rate.
    
    Specified by:
    
    convertAmountUsingMid in interface FxRate
    
    Parameters:
    
    originalAmount - the monetary amount (currency + amount)
    
    Returns:
    
    depending on the originalAmount.currency, it will be amount / mid or amount * mid, rounded to 2 DP.
  - convertAmountUsingBidOrAsk
```
public CurrencyAmount convertAmountUsingBidOrAsk(CurrencyAmount originalAmount)
```
    Description copied from interface: FxRate
    
    Given a monetary amount in the original currency, calculate the resulting amount in the other currency, using BID or ASK depending on the originalAmount.currency.
    
    Specified by:
    
    convertAmountUsingBidOrAsk in interface FxRate
    
    Parameters:
    
    originalAmount - the monetary amount (currency + amount)
    
    Returns:
    
    depending on the originalAmount.currency, it will be amount / bid|ask or amount * bid|ask, rounded to 2 DP.
  - getPaymentAmountForBuying
```
public CurrencyAmount getPaymentAmountForBuying(CurrencyAmount amountToBuy)
```
    Calculates the amount to pay given an amount to buy, e.g. how much should you pay in Y if you are buying n X? More explicitly, how many EURos should you pay to buy 1,000 USD? Given EUR/USD rate, this would be 1,000 / bid.
    
    Specified by:
    
    getPaymentAmountForBuying in interface FxRate
    
    Parameters:
    
    amountToBuy - amount you want to buy.
    
    Returns:
    
    amount you have to pay in the other ccy.
  - getReceiptAmountForSelling
```
public CurrencyAmount getReceiptAmountForSelling(CurrencyAmount amountToSell)
```
    Calculates the amount the seller would receive given an amount to sell, e.g. how many Y will you get if you are selling n X? More explicitly, how many EURos should you get to sell 1,000 USD? Given EUR/USD rate, this would be 1,000 / ask.
    
    Specified by:
    
    getReceiptAmountForSelling in interface FxRate
    
    Parameters:
    
    amountToSell - amount you want to sell.
    
    Returns:
    
    amount you will receive in the other ccy.

Class FxRateImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FxRateImpl

Method Detail

getDescription

createInverse

createInverse

getBid

getAsk

getCurrencyPair

getCrossCcy

isMarketConvention

getMid

getBidInMarketConvention

getMidInMarketConvention

getAskInMarketConvention

toString

convertAmountUsingMid

convertAmountUsingBidOrAsk

getPaymentAmountForBuying

getReceiptAmountForSelling