org.pepstock.charba.client.intl.enums

Enum CurrencyDisplay

java.lang.Object

java.lang.Enum<CurrencyDisplay>

org.pepstock.charba.client.intl.enums.CurrencyDisplay

All Implemented Interfaces:

Serializable, Comparable<CurrencyDisplay>, Key

public enum CurrencyDisplay
extends Enum<CurrencyDisplay>
implements Key

Enumerates the possible values how to display the currency in currency formatting.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE To use the ISO currency code.
NAME To use a localized currency name such as "dollar".
NARROW_SYMBOL To use a narrow format symbol ("$100" rather than "US$100").
SYMBOL To use a localized currency symbol such as €, this is the default value.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static CurrencyDisplay	valueOf(String name) Returns the enum constant of this type with the specified name.
static CurrencyDisplay[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

SYMBOL

public static final CurrencyDisplay SYMBOL

To use a localized currency symbol such as €, this is the default value.

NARROW_SYMBOL

public static final CurrencyDisplay NARROW_SYMBOL

To use a narrow format symbol ("$100" rather than "US$100").

CODE

public static final CurrencyDisplay CODE

To use the ISO currency code.

NAME

public static final CurrencyDisplay NAME

To use a localized currency name such as "dollar".

Method Detail

values

public static CurrencyDisplay[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CurrencyDisplay c : CurrencyDisplay.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CurrencyDisplay valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property