com.helger.photon.basic.app.menu

Enum EMenuObjectType

java.lang.Object

java.lang.Enum<EMenuObjectType>

com.helger.photon.basic.app.menu.EMenuObjectType

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EMenuObjectType>

public enum EMenuObjectType
extends Enum<EMenuObjectType>
implements com.helger.commons.id.IHasID<String>

Enumeration with the different type of menu objects.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTERNAL Menu item pointing to an external page
PAGE Menu item pointing to an internal page
SEPARATOR Separator

Method Summary

Modifier and Type	Method and Description
static EMenuObjectType	getFromIDOrNull(String sID)
String	getID()
boolean	isExternal()
boolean	isNotSeparator()
boolean	isPage()
boolean	isSeparator()
static EMenuObjectType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EMenuObjectType[]	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 com.helger.commons.id.IHasID

getComparatorID

Enum Constant Detail

SEPARATOR

public static final EMenuObjectType SEPARATOR

Separator

PAGE

public static final EMenuObjectType PAGE

Menu item pointing to an internal page

EXTERNAL

public static final EMenuObjectType EXTERNAL

Menu item pointing to an external page

Method Detail

values

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

Returns:

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

valueOf

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

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

isSeparator

public boolean isSeparator()

isNotSeparator

public boolean isNotSeparator()

isPage

public boolean isPage()

isExternal

public boolean isExternal()

getFromIDOrNull

@Nullable
public static EMenuObjectType getFromIDOrNull(@Nullable
                                                         String sID)