com.greatmancode.craftconomy3.currency

Class Currency

java.lang.Object

com.greatmancode.craftconomy3.currency.Currency

public class Currency
extends java.lang.Object

Represents a currency

Constructor Summary

Constructors

Constructor and Description
Currency(java.lang.String name, java.lang.String plural, java.lang.String minor, java.lang.String minorPlural, java.lang.String sign) Initialize a currency
Currency(java.lang.String name, java.lang.String plural, java.lang.String minor, java.lang.String minorPlural, java.lang.String sign, boolean status)
Currency(java.lang.String name, java.lang.String plural, java.lang.String minor, java.lang.String minorPlural, java.lang.String sign, boolean status, boolean bankCurrency)

Method Summary

Modifier and Type	Method and Description
double	getExchangeRate(Currency otherCurrency) Returns the exchange rate between 2 currency.
java.lang.String	getMinor() Get the currency minor name
java.lang.String	getMinorPlural() Get the currency minor name in plural
java.lang.String	getName() Get the currency name
java.lang.String	getPlural() Get the currency name in plural
java.lang.String	getSign() Retrieve the sign of the currency (Example $ for Dollars)
boolean	getStatus()
boolean	isPrimaryBankCurrency()
protected void	setBankCurrency(boolean bankCurrency)
protected void	setDefault(boolean status) Set the default flag to true.
void	setExchangeRate(Currency otherCurrency, double amount) Set the exchange rate between 2 currency
void	setMinor(java.lang.String minor) Set the currency minor name
void	setMinorPlural(java.lang.String minorPlural) Set the currency minor name in plural
void	setName(java.lang.String name) Set the currency name
void	setPlural(java.lang.String plural) Set the currency name in plural
void	setSign(java.lang.String sign) Sets the sign of the currency (Example $ for Dollars)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Currency

public Currency(java.lang.String name,
                java.lang.String plural,
                java.lang.String minor,
                java.lang.String minorPlural,
                java.lang.String sign)

Initialize a currency

Parameters:

name - The name of the currency

plural - The plural name of the currency

minor - The minor name of the currency

minorPlural - The plural minor name of the currency.

sign - The sign of the currency. (Example: $)

Currency

public Currency(java.lang.String name,
                java.lang.String plural,
                java.lang.String minor,
                java.lang.String minorPlural,
                java.lang.String sign,
                boolean status)

Currency

public Currency(java.lang.String name,
                java.lang.String plural,
                java.lang.String minor,
                java.lang.String minorPlural,
                java.lang.String sign,
                boolean status,
                boolean bankCurrency)

Method Detail

getName

public java.lang.String getName()

Get the currency name

Returns:

The currency Name

setName

public void setName(java.lang.String name)

Set the currency name

Parameters:

name - The currency name to set to.

getPlural

public java.lang.String getPlural()

Get the currency name in plural

Returns:

The currency name in plural

setPlural

public void setPlural(java.lang.String plural)

Set the currency name in plural

Parameters:

plural - The currency name in plural to set to.

getMinor

public java.lang.String getMinor()

Get the currency minor name

Returns:

The currency minor name

setMinor

public void setMinor(java.lang.String minor)

Set the currency minor name

Parameters:

minor - The currency minor name to set to

getMinorPlural

public java.lang.String getMinorPlural()

Get the currency minor name in plural

Returns:

The currency minor name in plural

setMinorPlural

public void setMinorPlural(java.lang.String minorPlural)

Set the currency minor name in plural

Parameters:

minorPlural - The currency minor name in plural to set to

setSign

public void setSign(java.lang.String sign)

Sets the sign of the currency (Example $ for Dollars)

Parameters:

sign - The Sign of the Currency.

getSign

public java.lang.String getSign()

Retrieve the sign of the currency (Example $ for Dollars)

Returns:

The sign.

getExchangeRate

public double getExchangeRate(Currency otherCurrency)
                       throws NoExchangeRate

Returns the exchange rate between 2 currency.

Parameters:

otherCurrency - The other currency to exchange to

Returns:

The exchange rate or Double.MIN_VALUE if no exchange information are found.

Throws:

NoExchangeRate - If there's no exchange rate between the 2 currencies.

setExchangeRate

public void setExchangeRate(Currency otherCurrency,
                            double amount)

Set the exchange rate between 2 currency

Parameters:

otherCurrency - The other currency

amount - THe exchange rate.

setDefault

protected void setDefault(boolean status)

Set the default flag to true.

Parameters:

status - If this currency is the default one or not

getStatus

public boolean getStatus()

isPrimaryBankCurrency

public boolean isPrimaryBankCurrency()

setBankCurrency

protected void setBankCurrency(boolean bankCurrency)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object