org.spongepowered.api.service.economy

Interface Currency

All Superinterfaces:

CatalogType

public interface Currency
extends CatalogType

Represents a form of currency. At least one type of currency is always supported.

Unlike other CatalogTypes, Currency has no predefined values. Unless a plugin has specific knowledge of a particular currency provided by an economy plugin, EconomyService.getDefaultCurrency() should usually be used.

Depending on the provider of the EconomyService, more currencies may be available.

Method Summary

Modifier and Type	Method and Description
default Text	format(BigDecimal amount) Formats the given amount using the default number of fractional digits.
Text	format(BigDecimal amount, int numFractionDigits) Formats the given amount using the specified number of fractional digits.
int	getDefaultFractionDigits() This is the default number of fractional digits that is utilized for formatting purposes.
Text	getDisplayName() The currency's display name, in singular form.
Text	getPluralDisplayName() The currency's display name in plural form.
Text	getSymbol() The currency's symbol.
boolean	isDefault() Returns true if this currency is the default currency for the economy, otherwise false.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

getDisplayName

Text getDisplayName()

The currency's display name, in singular form. Ex: Dollar.

This should be preferred over CatalogType.getName() for display purposes.

Returns:

displayName of the currency singular

getPluralDisplayName

Text getPluralDisplayName()

The currency's display name in plural form. Ex: Dollars.

Not all currencies will have a plural name that differs from the display name.

Returns:

displayName of the currency plural

getSymbol

Text getSymbol()

The currency's symbol. Ex. $

Returns:

symbol of the currency

format

default Text format(BigDecimal amount)

Formats the given amount using the default number of fractional digits.

Should include the symbol if it is present

Parameters:

amount - The amount to format

Returns:

String formatted amount

format

Text format(BigDecimal amount,
            int numFractionDigits)

Formats the given amount using the specified number of fractional digits.

Should include the symbol if it is present

Parameters:

amount - The amount to format

numFractionDigits - The numer of fractional digits to use

Returns:

String formatted amount.

getDefaultFractionDigits

int getDefaultFractionDigits()

This is the default number of fractional digits that is utilized for formatting purposes.

Returns:

defaultFractionDigits utilized.

isDefault

boolean isDefault()

Returns true if this currency is the default currency for the economy, otherwise false.

Returns:

true if this is the default currency