io.github.ageofwar.telejam.payments

Class Currency

java.lang.Object

io.github.ageofwar.telejam.payments.Currency

All Implemented Interfaces:

TelegramObject, java.io.Serializable

public class Currency
extends java.lang.Object
implements TelegramObject

Information about a currency.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Currency(java.lang.String code, java.lang.String title, java.lang.String symbol, java.lang.String nativeSymbol, java.lang.String thousandsSeparator, java.lang.String decimalSeparator, boolean symbolLeft, boolean spaceBetween, int exponent, int minAmount, int maxAmount) Creates a Currency.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(int value, boolean useNativeSymbol) Converts a value to a price with this currency.
static Currency	fromCode(java.lang.String code) Returns the currency with the specified code.
java.lang.String	getCode() Getter for property code.
java.lang.String	getDecimalSeparator() Getter for property decimalSeparator.
int	getExponent() Getter for property exponent.
int	getMaxAmount() Getter for property maxAmount.
int	getMinAmount() Getter for property minAmount.
java.lang.String	getNativeSymbol() Getter for property nativeSymbol.
java.lang.String	getSymbol() Getter for property symbol.
java.lang.String	getThousandsSeparator() Getter for property thousandsSeparator.
java.lang.String	getTitle() Getter for property title.
static void	init() Loads currencies from the Telegram API.
boolean	isSpaceBetween() Getter for property spaceBetween.
boolean	isSymbolLeft() Getter for property symbolLeft.

Methods inherited from class java.lang.Object

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

Constructor Detail

Currency

public Currency(java.lang.String code,
                java.lang.String title,
                java.lang.String symbol,
                java.lang.String nativeSymbol,
                java.lang.String thousandsSeparator,
                java.lang.String decimalSeparator,
                boolean symbolLeft,
                boolean spaceBetween,
                int exponent,
                int minAmount,
                int maxAmount)

Creates a Currency.

Parameters:

code - three-letter ISO 4217 currency code

title - the title of the currency

symbol - the symbol of the currency

nativeSymbol - the native symbol of the currency

thousandsSeparator - the thousands separator of the currency

decimalSeparator - the decimal separator of the currency

symbolLeft - true if the symbol is on the left, false otherwise

spaceBetween - true if there is a space between the value and the symbol, false otherwise

exponent - maximum number of decimal digits

minAmount - minimum amount of price

maxAmount - maximum amount of price

Method Detail

init

public static void init()
                 throws java.io.IOException

Loads currencies from the Telegram API.

Throws:

java.io.IOException - if an IOException occurs

fromCode

public static Currency fromCode(java.lang.String code)

Returns the currency with the specified code.

Parameters:

code - the code

Returns:

the currency with the specified code

format

public java.lang.String format(int value,
                               boolean useNativeSymbol)

Converts a value to a price with this currency.

Parameters:

value - the value

useNativeSymbol - true if you want to use the native symbol of the currency

Returns:

the formatted price

getCode

public java.lang.String getCode()

Getter for property code.

Returns:

value for property code

getTitle

public java.lang.String getTitle()

Getter for property title.

Returns:

value for property title

getSymbol

public java.lang.String getSymbol()

Getter for property symbol.

Returns:

value for property symbol

getNativeSymbol

public java.lang.String getNativeSymbol()

Getter for property nativeSymbol.

Returns:

value for property nativeSymbol

getThousandsSeparator

public java.lang.String getThousandsSeparator()

Getter for property thousandsSeparator.

Returns:

value for property thousandsSeparator

getDecimalSeparator

public java.lang.String getDecimalSeparator()

Getter for property decimalSeparator.

Returns:

value for property decimalSeparator

isSymbolLeft

public boolean isSymbolLeft()

Getter for property symbolLeft.

Returns:

value for property symbolLeft

isSpaceBetween

public boolean isSpaceBetween()

Getter for property spaceBetween.

Returns:

value for property spaceBetween

getExponent

public int getExponent()

Getter for property exponent.

Returns:

value for property exponent

getMinAmount

public int getMinAmount()

Getter for property minAmount.

Returns:

value for property minAmount

getMaxAmount

public int getMaxAmount()

Getter for property maxAmount.

Returns:

value for property maxAmount