net.objectlab.kit.fxcalc

Class CurrencyPair

java.lang.Object

net.objectlab.kit.fxcalc.CurrencyPair

public class CurrencyPair
extends Object

Immutable class representing a Currency pair, ccy1/ccy2; thread-safe and able to be used in Collections. Note that the currencies will be converted to UPPER CASE.

Constructor Summary

Constructors

Constructor and Description
CurrencyPair(String ccy1, String ccy2)

Method Summary

Modifier and Type	Method and Description
boolean	containsCcy(String ccy)
CurrencyPair	createInverse() Returns a new CurrencyPair ccy2 / ccy1 (useful for FxRate).
boolean	equals(Object obj)
Optional<String>	findCommonCcy(CurrencyPair otherPair) Given another CurrencyPair find the common Currency (if any) or the first if both are identical
String	getCcy1()
String	getCcy2()
int	hashCode()
static CurrencyPair	of(String ccy1, String ccy2)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CurrencyPair

public CurrencyPair(String ccy1,
                    String ccy2)

Throws:

IllegalArgumentException - if ccy1 or ccy2 are blank.

Method Detail

of

public static CurrencyPair of(String ccy1,
                              String ccy2)

getCcy1

public String getCcy1()

getCcy2

public String getCcy2()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

containsCcy

public boolean containsCcy(String ccy)

findCommonCcy

public Optional<String> findCommonCcy(CurrencyPair otherPair)

Given another CurrencyPair find the common Currency (if any) or the first if both are identical

Parameters:

otherPair -

Returns:

the common ccy or Empty optional

createInverse

public CurrencyPair createInverse()

Returns a new CurrencyPair ccy2 / ccy1 (useful for FxRate).