org.pepstock.charba.client.commons

Enum Id

java.lang.Object

java.lang.Enum<Id>

org.pepstock.charba.client.commons.Id

All Implemented Interfaces:

Serializable, Comparable<Id>, Key

public enum Id
extends Enum<Id>
implements Key

Enums the property ID used by CHARBA to identify the chart.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHARBA_ID Name of java script property

Method Summary

Modifier and Type	Method and Description
static int	get(Key key, NativeObject nativeObject) Returns the property value from java script object, when the ID is stored as integer
static String	get(NativeObject nativeObject) Returns the property value from java script object.
static String	get(NativeObjectContainer nativeObjectContainer) Returns the property value from java script object.
String	value() Returns the name value of property
static Id	valueOf(String name) Returns the enum constant of this type with the specified name.
static Id[]	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

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

Enum Constant Detail

CHARBA_ID

public static final Id CHARBA_ID

Name of java script property

Method Detail

values

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

Returns:

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

valueOf

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

get

public static String get(NativeObjectContainer nativeObjectContainer)

Returns the property value from java script object.

Parameters:

nativeObjectContainer - java script object container

Returns:

the property value or UndefinedValues.STRING if not exist

get

public static String get(NativeObject nativeObject)

Returns the property value from java script object.

Parameters:

nativeObject - java script object

Returns:

the property value or UndefinedValues.STRING if not exist

get

public static int get(Key key,
                      NativeObject nativeObject)

Returns the property value from java script object, when the ID is stored as integer

Parameters:

key - the key to search inside the object

nativeObject - java script object

Returns:

the property value or UndefinedValues.INTEGER if not exist