org.opencms.jsp

Enum CmsJspNavBuilder.Visibility

java.lang.Object

java.lang.Enum<CmsJspNavBuilder.Visibility>

org.opencms.jsp.CmsJspNavBuilder.Visibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsJspNavBuilder.Visibility>

Enclosing class:

CmsJspNavBuilder

public static enum CmsJspNavBuilder.Visibility
extends java.lang.Enum<CmsJspNavBuilder.Visibility>

The visibility mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
all All entries.
includeHidden Navigation including hidden entries.
navigation Navigation only.

Method Summary

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

all

public static final CmsJspNavBuilder.Visibility all

All entries.

includeHidden

public static final CmsJspNavBuilder.Visibility includeHidden

Navigation including hidden entries.

navigation

public static final CmsJspNavBuilder.Visibility navigation

Navigation only.

Method Detail

values

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

Returns:

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

valueOf

public static CmsJspNavBuilder.Visibility 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