com.atlassian.gadgets

Enum DashboardItemType

java.lang.Object

java.lang.Enum<DashboardItemType>

com.atlassian.gadgets.DashboardItemType

All Implemented Interfaces:

Serializable, Comparable<DashboardItemType>

public enum DashboardItemType
extends Enum<DashboardItemType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL_DASHBOARD_ITEM
OPEN_SOCIAL_GADGET

Method Summary

Modifier and Type	Method and Description
static io.atlassian.fugue.Option<DashboardItemType>	forName(String name)
String	getName()
boolean	isOpenSocialGadget() Determines whether or not the item type is for an open social gadget or a local dashboard item.
static DashboardItemType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DashboardItemType[]	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 Detail

LOCAL_DASHBOARD_ITEM

public static final DashboardItemType LOCAL_DASHBOARD_ITEM

OPEN_SOCIAL_GADGET

public static final DashboardItemType OPEN_SOCIAL_GADGET

Method Detail

values

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

Returns:

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

valueOf

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

forName

public static io.atlassian.fugue.Option<DashboardItemType> forName(String name)

getName

public String getName()

isOpenSocialGadget

public boolean isOpenSocialGadget()

Determines whether or not the item type is for an open social gadget or a local dashboard item.

Returns:

true if it is an open social gadget.