Package org.opencms.ui.favorites

Enum Class CmsFavoriteEntry.Type

java.lang.Object

java.lang.Enum<CmsFavoriteEntry.Type>

org.opencms.ui.favorites.CmsFavoriteEntry.Type

All Implemented Interfaces:

Serializable, Comparable<CmsFavoriteEntry.Type>, Constable

Enclosing class:

CmsFavoriteEntry

public static enum CmsFavoriteEntry.Type
extends Enum<CmsFavoriteEntry.Type>

Represents the type of the favorite.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
explorerFolder	Container page editor favorite.
page	Page favorite.

Method Summary

Modifier and Type	Method	Description
static CmsFavoriteEntry.Type	fromJsonId(String id)	Converts JSON id to correct type.
String	getJsonId()	Gets the JSON id for the type.
static CmsFavoriteEntry.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmsFavoriteEntry.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

explorerFolder

public static final CmsFavoriteEntry.Type explorerFolder

Container page editor favorite.

page

public static final CmsFavoriteEntry.Type page

Page favorite.

Method Details

values

public static CmsFavoriteEntry.Type[] values()

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

Returns:

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

valueOf

public static CmsFavoriteEntry.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromJsonId

public static CmsFavoriteEntry.Type fromJsonId(String id)

Converts JSON id to correct type.

Parameters:

id - the JSON id

Returns:

the corresponding type

getJsonId

public String getJsonId()

Gets the JSON id for the type.

Returns:

the JSON id