Package com.xwiki.macros.confluence

Enum ConfluenceTocZoneMacroLocationParameter

java.lang.Object

java.lang.Enum<ConfluenceTocZoneMacroLocationParameter>

com.xwiki.macros.confluence.ConfluenceTocZoneMacroLocationParameter

All Implemented Interfaces:

Serializable, Comparable<ConfluenceTocZoneMacroLocationParameter>

public enum ConfluenceTocZoneMacroLocationParameter
extends Enum<ConfluenceTocZoneMacroLocationParameter>

Defines where the Table of Contents should appear.

Since:

1.23.0

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Display the TOC both above and below the macro's content.
BOTTOM	Display the TOC below the macro's content.
TOP	Display the TOC above the macro's content.

Method Summary

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

TOP

public static final ConfluenceTocZoneMacroLocationParameter TOP

Display the TOC above the macro's content.

BOTTOM

public static final ConfluenceTocZoneMacroLocationParameter BOTTOM

Display the TOC below the macro's content.

BOTH

public static final ConfluenceTocZoneMacroLocationParameter BOTH

Display the TOC both above and below the macro's content. Note: This is the default.

Method Detail

values

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

Returns:

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

valueOf

public static ConfluenceTocZoneMacroLocationParameter 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