net.objectlab.kit.fxcalc

Interface FxRate

All Known Implementing Classes:

FxRateImpl

public interface FxRate

Represents a read-only view on an FxRate.

Author:

Benoit Xhenseval

Method Summary

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.

Method Detail

getCurrencyPair

CurrencyPair getCurrencyPair()

The CurrencyPair as in Ccy1/Ccy2 where the Bid will be the price for selling ccy1 and buying ccy2.

getCrossCcy

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.

isMarketConvention

boolean isMarketConvention()

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?)

getBid

BigDecimal getBid()

The price at which the 'quoter' is willing to sell ccy1 and buy ccy2.

getMid

BigDecimal getMid()

Mid = (bid + ask) / 2

getAsk

BigDecimal getAsk()

The price at which the 'quoter' is willing to buy ccy1 and sell ccy2.

getBidInMarketConvention

BigDecimal getBidInMarketConvention()

Useful for human readable display, returns the same value as Bid if FxRate is in market convention otherwise 1/ask.

getMidInMarketConvention

BigDecimal getMidInMarketConvention()

Mid = (bid + ask) / 2

getAskInMarketConvention

BigDecimal getAskInMarketConvention()

Useful for human readable display, returns the same value as Ask if FxRate is in market convention otherwise 1/bid.

createInverse

FxRate createInverse()

Create the FX Rate for ccy2 / ccy1, return a new FxRate; the inverse of bid / ask are swapped around.

createInverse

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.

getDescription

String getDescription()

Nice human readable description of the FX Rate, useful reminder.

convertAmountUsingMid

CurrencyAmount convertAmountUsingMid(CurrencyAmount originalAmount)

Given a monetary amount in the original currency, calculate the resulting amount in the other currency, using MID rate.

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.

Throws:

IllegalArgumentException - if the originalAmount.currency is not one of the currency pair.

convertAmountUsingBidOrAsk

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.

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.

Throws:

IllegalArgumentException - if the originalAmount.currency is not one of the currency pair.

getPaymentAmountForBuying

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.

Parameters:

amountToBuy - amount you want to buy.

Returns:

amount you have to pay in the other currency.

getReceiptAmountForSelling

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.

Parameters:

amountToSell - amount you want to sell.

Returns:

amount you will receive in the other currency.