org.opencms.ui.favorites

Enum CmsFavoriteEntry.Type

java.lang.Object

java.lang.Enum<CmsFavoriteEntry.Type>

org.opencms.ui.favorites.CmsFavoriteEntry.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsFavoriteEntry.Type>

Enclosing class:

CmsFavoriteEntry

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

Represents the type of the favorite.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static CmsFavoriteEntry.Type	fromJsonId(java.lang.String id) Converts JSON id to correct type.
java.lang.String	getJsonId() Gets the JSON id for the type.
static CmsFavoriteEntry.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsFavoriteEntry.Type[]	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

explorerFolder

public static final CmsFavoriteEntry.Type explorerFolder

Container page editor favorite.

page

public static final CmsFavoriteEntry.Type page

Page favorite.

Method Detail

values

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

Returns:

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

valueOf

public static CmsFavoriteEntry.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromJsonId

public static CmsFavoriteEntry.Type fromJsonId(java.lang.String id)

Converts JSON id to correct type.

Parameters:

id - the JSON id

Returns:

the corresponding type

getJsonId

public java.lang.String getJsonId()

Gets the JSON id for the type.

Returns:

the JSON id