com.knowgate.currency

Class CurrencyCode

java.lang.Object

com.knowgate.currency.CurrencyCode

public final class CurrencyCode
extends Object

Currency Code

Version:

1.0

Author:

Sergio Montoro Ten

Field Summary

Fields

Modifier and Type	Field and Description
static CurrencyCode	CNY
static CurrencyCode	EUR
static CurrencyCode	GBP
static CurrencyCode	JPY
static CurrencyCode	RUB
static CurrencyCode	USD

Constructor Summary

Constructors

Constructor and Description
CurrencyCode(int iNum, String sAlpha, String sSign, String sId, String sNm, String sTrEn) Constructor

Method Summary

Modifier and Type	Method and Description
String	alphaCode()
String	countryCode()
Currency	currency() Corresponding java.util.Currency object
static CurrencyCode	currencyCodeFor(int iNumCode)
static CurrencyCode	currencyCodeFor(String sAlphaCode) Get CurrencyCode for a 3 letter currency identifier
String	currencyName() Currency name in English language
boolean	equals(CurrencyCode oCurCod) Two currencies will be the same if the have the same alphaCode()
int	hashCode()
int	numericCode()
String	singleCharSign()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CNY

public static final CurrencyCode CNY

EUR

public static final CurrencyCode EUR

GBP

public static final CurrencyCode GBP

JPY

public static final CurrencyCode JPY

USD

public static final CurrencyCode USD

RUB

public static final CurrencyCode RUB

Constructor Detail

CurrencyCode

public CurrencyCode(int iNum,
                    String sAlpha,
                    String sSign,
                    String sId,
                    String sNm,
                    String sTrEn)
             throws NullPointerException,
                    IllegalArgumentException

Constructor

Parameters:

iNum - int Currency Numeric Code

sAlpha - String ISO 4217 3-letter code

sSign - String "$", "€", "£", etc.

sId - String ISO-639 two letter country code

sNm - String Country Name

sTrEn - String Currency Name (in English)

Throws:

NullPointerException - if currencyCode is null

IllegalArgumentException - if currencyCode is not a supported ISO 4217 code.

Method Detail

currency

public Currency currency()

Corresponding java.util.Currency object

Returns:

Currency

countryCode

public String countryCode()

Returns:

String ISO-639 two letter country code in lower case

alphaCode

public String alphaCode()

Returns:

Three letter currency code in upper case

singleCharSign

public String singleCharSign()

Returns:

String A single sign like $ € £ ¥

currencyName

public String currencyName()

Currency name in English language

Returns:

String

numericCode

public int numericCode()

Returns:

int Currency numeric code

equals

public boolean equals(CurrencyCode oCurCod)

Two currencies will be the same if the have the same alphaCode()

Parameters:

oCurCod - CurrencyCode

Returns:

boolean

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

String Currency three letter currency code in upper case.

currencyCodeFor

public static CurrencyCode currencyCodeFor(String sAlphaCode)

Get CurrencyCode for a 3 letter currency identifier

Parameters:

sAlphaCode -

Returns:

CurrencyCode instance for given code or null if no currency was found for that code

currencyCodeFor

public static CurrencyCode currencyCodeFor(int iNumCode)