Package com.xwiki.projectmanagement.chart

Enum ChartPeriod

java.lang.Object

java.lang.Enum<ChartPeriod>

com.xwiki.projectmanagement.chart.ChartPeriod

All Implemented Interfaces:

Serializable, Comparable<ChartPeriod>

@Unstable
public enum ChartPeriod
extends Enum<ChartPeriod>

Define the possible period of time to use for displaying the charts that group their data on date types.

Since:

1.2.0-rc-1

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY	To retrieve data split by day.
HOURLY	To retrieve data split by hour.
MONTHLY	To retrieve data split by month.
YEARLY	To retrieve data split by year.

Method Summary

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

Enum Constant Details

HOURLY

public static final ChartPeriod HOURLY

To retrieve data split by hour.

DAILY

public static final ChartPeriod DAILY

To retrieve data split by day.

MONTHLY

public static final ChartPeriod MONTHLY

To retrieve data split by month.

YEARLY

public static final ChartPeriod YEARLY

To retrieve data split by year.

Method Details

values

public static ChartPeriod[] values()

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

Returns:

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

valueOf

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