Package com.xwiki.macros.confluence

Enum ConfluenceTocZoneMacroTypeParameter

java.lang.Object

java.lang.Enum<ConfluenceTocZoneMacroTypeParameter>

com.xwiki.macros.confluence.ConfluenceTocZoneMacroTypeParameter

All Implemented Interfaces:

Serializable, Comparable<ConfluenceTocZoneMacroTypeParameter>

public enum ConfluenceTocZoneMacroTypeParameter
extends Enum<ConfluenceTocZoneMacroTypeParameter>

Defines the style for the Table of Contents.

Since:

1.23.0

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLAT	The Table of Contents is displayed in one line.
LIST	The Table of Contents is displayed as a vertical list.

Method Summary

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

LIST

public static final ConfluenceTocZoneMacroTypeParameter LIST

The Table of Contents is displayed as a vertical list.

FLAT

public static final ConfluenceTocZoneMacroTypeParameter FLAT

The Table of Contents is displayed in one line.

Method Details

values

public static ConfluenceTocZoneMacroTypeParameter[] values()

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

Returns:

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

valueOf

public static ConfluenceTocZoneMacroTypeParameter 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 name

NullPointerException - if the argument is null