org.pepstock.charba.client.enums

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.pepstock.charba.client.enums.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>, Key

public enum TimeUnit
extends Enum<TimeUnit>
implements Key

Controls the data distribution along the scale.
About available formats, see moment.js.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY Day time unit
HOUR Hour time unit
MILLISECOND Millisecond time unit
MINUTE Minute time unit
MONTH Month time unit
QUARTER Quarter time unit
SECOND Second time unit
UNKNOWN Unknown
WEEK Week time unit
YEAR Year time unit

Method Summary

Modifier and Type	Method and Description
String	getDefaultFormat() returns the default format for the time unit.
String	value() Returns the name value of property
static TimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeUnit[]	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

MILLISECOND

public static final TimeUnit MILLISECOND

Millisecond time unit

SECOND

public static final TimeUnit SECOND

Second time unit

MINUTE

public static final TimeUnit MINUTE

Minute time unit

HOUR

public static final TimeUnit HOUR

Hour time unit

DAY

public static final TimeUnit DAY

Day time unit

WEEK

public static final TimeUnit WEEK

Week time unit

MONTH

public static final TimeUnit MONTH

Month time unit

QUARTER

public static final TimeUnit QUARTER

Quarter time unit

YEAR

public static final TimeUnit YEAR

Year time unit

UNKNOWN

public static final TimeUnit UNKNOWN

Unknown

Method Detail

values

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

Returns:

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

valueOf

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

getDefaultFormat

public String getDefaultFormat()

returns the default format for the time unit.

Returns:

the format