net.objectlab.kit.fxcalc

Class MajorCurrencyRankingImpl

java.lang.Object

net.objectlab.kit.fxcalc.MajorCurrencyRankingImpl

All Implemented Interfaces:

MajorCurrencyRanking

Direct Known Subclasses:

StandardMajorCurrencyRanking

public class MajorCurrencyRankingImpl
extends Object
implements MajorCurrencyRanking

Utility class to determine the market convention for the FX Rate for a given currency pair. See https://en.wikipedia.org/wiki/Currency_pair, for a conventional list but the user can provide the ordered list of major currencies.

Constructor Summary

Constructors

Constructor and Description
MajorCurrencyRankingImpl(List<String> orderedCurrencies) User can define their own ordered list of major currencies

Method Summary

Modifier and Type	Method and Description
boolean	isMarketConvention(CurrencyPair pair) returns true if the pair.ccy1 is the major one for the given currency pair.
boolean	isMarketConvention(String ccy1, String ccy2) returns true if the ccy1 is the major one for the given currency pair.
String	selectMajorCurrency(CurrencyPair pair) Given a CurrencyPair, return the major Currency if there is one, otherwise returns the first currency.
String	selectMajorCurrency(String ccy1, String ccy2) Given 2 currencies, return the major one if there is one, otherwise returns the first currency.

Methods inherited from class java.lang.Object

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

Constructor Detail

MajorCurrencyRankingImpl

public MajorCurrencyRankingImpl(List<String> orderedCurrencies)

User can define their own ordered list of major currencies

Parameters:

orderedCurrencies - must be ordered!

Method Detail

selectMajorCurrency

public String selectMajorCurrency(String ccy1,
                                  String ccy2)

Given 2 currencies, return the major one if there is one, otherwise returns the first currency.

Specified by:

selectMajorCurrency in interface MajorCurrencyRanking

Returns:

Given 2 currencies, return the major one if there is one, otherwise returns the first currency.

selectMajorCurrency

public String selectMajorCurrency(CurrencyPair pair)

Given a CurrencyPair, return the major Currency if there is one, otherwise returns the first currency.

Specified by:

selectMajorCurrency in interface MajorCurrencyRanking

Returns:

Given a CurrencyPair, return the major Currency if there is one, otherwise returns the first currency.

isMarketConvention

public boolean isMarketConvention(String ccy1,
                                  String ccy2)

returns true if the ccy1 is the major one for the given currency pair.

Specified by:

isMarketConvention in interface MajorCurrencyRanking

Returns:

true if the ccy1 is the major one for the given currency pair.

isMarketConvention

public boolean isMarketConvention(CurrencyPair pair)

returns true if the pair.ccy1 is the major one for the given currency pair.

Specified by:

isMarketConvention in interface MajorCurrencyRanking

Returns:

true if the pair.ccy1 is the major one for the given currency pair.