org.opencms.ade.sitemap.shared

Enum CmsClientSitemapEntry.EntryType

java.lang.Object

java.lang.Enum<CmsClientSitemapEntry.EntryType>

org.opencms.ade.sitemap.shared.CmsClientSitemapEntry.EntryType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsClientSitemapEntry.EntryType>

Enclosing class:

CmsClientSitemapEntry

public static enum CmsClientSitemapEntry.EntryType
extends java.lang.Enum<CmsClientSitemapEntry.EntryType>

An enum for the entry type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
folder The default type.
leaf An entry of type leaf doesn't have any children.
navigationLevel A folder without default file, linking to it's first child entry.
redirect A redirect entry.
subSitemap An entry of type sub-sitemap is a reference to a sub-sitemap.

Method Summary

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

folder

public static final CmsClientSitemapEntry.EntryType folder

The default type. An entry of type folder may have children.

leaf

public static final CmsClientSitemapEntry.EntryType leaf

An entry of type leaf doesn't have any children.

navigationLevel

public static final CmsClientSitemapEntry.EntryType navigationLevel

A folder without default file, linking to it's first child entry.

redirect

public static final CmsClientSitemapEntry.EntryType redirect

A redirect entry.

subSitemap

public static final CmsClientSitemapEntry.EntryType subSitemap

An entry of type sub-sitemap is a reference to a sub-sitemap.

Method Detail

values

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

Returns:

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

valueOf

public static CmsClientSitemapEntry.EntryType 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