org.opencms.jsp

Enum CmsJspTagNavigation.Type

java.lang.Object

java.lang.Enum<CmsJspTagNavigation.Type>

org.opencms.jsp.CmsJspTagNavigation.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsJspTagNavigation.Type>

Enclosing class:

CmsJspTagNavigation

public static enum CmsJspTagNavigation.Type
extends java.lang.Enum<CmsJspTagNavigation.Type>

Constants for type attribute interpretation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
breadCrumb Bread crumb navigation.
forFolder Navigation for folder.
forResource Navigation for resource.
forSite Navigation for a site.
treeForFolder Navigation tree for folder.

Method Summary

Modifier and Type	Method and Description
static CmsJspTagNavigation.Type	parse(java.lang.String name) Parses a string into an enumeration element.
static CmsJspTagNavigation.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsJspTagNavigation.Type[]	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

breadCrumb

public static final CmsJspTagNavigation.Type breadCrumb

Bread crumb navigation.

forFolder

public static final CmsJspTagNavigation.Type forFolder

Navigation for folder.

forResource

public static final CmsJspTagNavigation.Type forResource

Navigation for resource.

forSite

public static final CmsJspTagNavigation.Type forSite

Navigation for a site.

treeForFolder

public static final CmsJspTagNavigation.Type treeForFolder

Navigation tree for folder.

Method Detail

values

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

Returns:

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

valueOf

public static CmsJspTagNavigation.Type 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

parse

public static CmsJspTagNavigation.Type parse(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Parses a string into an enumeration element.

Parameters:

name - the name of the enumeration element

Returns:

the enumeration element with the given name

Throws:

java.lang.IllegalArgumentException - in case of an invalid enumeration name