Enum SitemapContextType
- java.lang.Object
-
- java.lang.Enum<SitemapContextType>
-
- org.ametys.web.frontoffice.search.instance.model.SitemapContextType
-
- All Implemented Interfaces:
Serializable
,Comparable<SitemapContextType>
public enum SitemapContextType extends Enum<SitemapContextType>
A sitemap context type
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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()
.CURRENT_SITE
The sitemap of the context is the whole sitemap of the current site.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()
.
-
Constructor Summary
Constructors Modifier Constructor Description private
SitemapContextType()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SitemapContextType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SitemapContextType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CURRENT_SITE
public static final SitemapContextType CURRENT_SITE
The sitemap of the context is the whole sitemap of the current site.
-
CHILD_PAGES
public static final SitemapContextType CHILD_PAGES
The sitemap of the context is all child pages of the current page.
-
CHILD_PAGES_OF
public static final SitemapContextType CHILD_PAGES_OF
The sitemap of the context is all child pages of the pages returned bySitemapContext.getPages()
.
-
DIRECT_CHILD_PAGES
public static final SitemapContextType DIRECT_CHILD_PAGES
The sitemap of the context is direct child pages of the current page.
-
DIRECT_CHILD_PAGES_OF
public static final SitemapContextType DIRECT_CHILD_PAGES_OF
The sitemap of the context is direct child pages of the pages returned bySitemapContext.getPages()
.
-
-
Constructor Detail
-
SitemapContextType
private SitemapContextType()
-
-
Method Detail
-
values
public static SitemapContextType[] 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 (SitemapContextType c : SitemapContextType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SitemapContextType 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 nameNullPointerException
- if the argument is null
-
-