org.pepstock.charba.client.intl.enums

Enum CompactDisplay

java.lang.Object

java.lang.Enum<CompactDisplay>

org.pepstock.charba.client.intl.enums.CompactDisplay

All Implemented Interfaces:

Serializable, Comparable<CompactDisplay>, Key

public enum CompactDisplay
extends Enum<CompactDisplay>
implements Key

Enumerates the possible display when the formatting, that should be displayed for the number, is compact.
Takes either "short" (default) or "long".

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
LONG Long formatting to display the number.
SHORT Short formatting to display the number.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static CompactDisplay	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompactDisplay[]	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

SHORT

public static final CompactDisplay SHORT

Short formatting to display the number.

LONG

public static final CompactDisplay LONG

Long formatting to display the number.

Method Detail

values

public static CompactDisplay[] 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 (CompactDisplay c : CompactDisplay.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompactDisplay 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