org.opencms.configuration

Enum CmsDefaultUserSettings.SubsitemapCreationMode

java.lang.Object

java.lang.Enum<CmsDefaultUserSettings.SubsitemapCreationMode>

org.opencms.configuration.CmsDefaultUserSettings.SubsitemapCreationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsDefaultUserSettings.SubsitemapCreationMode>

Enclosing class:

CmsDefaultUserSettings

public static enum CmsDefaultUserSettings.SubsitemapCreationMode
extends java.lang.Enum<CmsDefaultUserSettings.SubsitemapCreationMode>

Enum for the subsitemap creation mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
convert In this mode, existing folders are converted into subsitemaps.
createfolder In this mode, new subsitemap folders are created, giving the user a choice of which folder type they want to use.

Method Summary

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

convert

public static final CmsDefaultUserSettings.SubsitemapCreationMode convert

In this mode, existing folders are converted into subsitemaps.

createfolder

public static final CmsDefaultUserSettings.SubsitemapCreationMode createfolder

In this mode, new subsitemap folders are created, giving the user a choice of which folder type they want to use.

Method Detail

values

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

Returns:

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

valueOf

public static CmsDefaultUserSettings.SubsitemapCreationMode 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