Enum Class SitemapContextType
java.lang.Object
java.lang.Enum<SitemapContextType>
org.ametys.web.frontoffice.search.instance.model.SitemapContextType
- All Implemented Interfaces:
Serializable
,Comparable<SitemapContextType>
,java.lang.constant.Constable
A sitemap context type
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe sitemap of the context is all child pages of the current page.The sitemap of the context is all child pages of the pages returned bySitemapContext.getPages()
.The sitemap of the context is the whole sitemap of the current site.The sitemap of the context is direct child pages of the current page.The sitemap of the context is direct child pages of the pages returned bySitemapContext.getPages()
. -
Method Summary
Modifier and TypeMethodDescriptionstatic SitemapContextType
Returns the enum constant of this class with the specified name.static SitemapContextType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CURRENT_SITE
The sitemap of the context is the whole sitemap of the current site. -
CHILD_PAGES
The sitemap of the context is all child pages of the current page. -
CHILD_PAGES_OF
The sitemap of the context is all child pages of the pages returned bySitemapContext.getPages()
. -
DIRECT_CHILD_PAGES
The sitemap of the context is direct child pages of the current page. -
DIRECT_CHILD_PAGES_OF
The sitemap of the context is direct child pages of the pages returned bySitemapContext.getPages()
.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-