Package com.broadleafcommerce.menu.domain.type

Enum Class MenuItemType

java.lang.Object

java.lang.Enum<MenuItemType>

com.broadleafcommerce.menu.domain.type.MenuItemType

All Implemented Interfaces:

Serializable, Comparable<MenuItemType>, Constable

public enum MenuItemType
extends Enum<MenuItemType>

Defines the default possible types for MenuItems. This is can be helpful to the frontend when determining how to render the content related to the MenuItem.getUrl().

Author:

Nathan Moore (nathandmoore)

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
ASSET	Signifies that an item is an asset such as an image.
CATEGORY	Signifies that an item leads to a category landing page.
CONTENT_ITEM	Signifies that an item leads a Content Item landing page.
CONTENT_MODEL	Signifies that an item leads a Content Model landing page, e.g., /blogs.
LINK	Signifies that an item is a generic hyperlink.
PAGE	Signifies that an item leads to a CMS page.
PRODUCT	Signifies that an item leads to a product detail page.
TEXT	Signifies that an item is simple text.

Method Summary

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

CATEGORY

public static final MenuItemType CATEGORY

Signifies that an item leads to a category landing page.

ASSET

public static final MenuItemType ASSET

Signifies that an item is an asset such as an image.

LINK

public static final MenuItemType LINK

Signifies that an item is a generic hyperlink.

PAGE

public static final MenuItemType PAGE

Signifies that an item leads to a CMS page.

CONTENT_MODEL

public static final MenuItemType CONTENT_MODEL

Signifies that an item leads a Content Model landing page, e.g., /blogs. This is primarily useful in coordination with the metadata to render a Content Model lookup rather than a manual input.

CONTENT_ITEM

public static final MenuItemType CONTENT_ITEM

Signifies that an item leads a Content Item landing page. This is primarily useful in coordination with the metadata to render a Content Item lookup rather than a manual input.

PRODUCT

public static final MenuItemType PRODUCT

Signifies that an item leads to a product detail page.

TEXT

public static final MenuItemType TEXT

Signifies that an item is simple text.

Method Details

values

public static MenuItemType[] 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 MenuItemType 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