org.xwiki.rendering.macro.toc

Enum TocMacroParameters.Scope

java.lang.Object

java.lang.Enum<TocMacroParameters.Scope>

org.xwiki.rendering.macro.toc.TocMacroParameters.Scope

All Implemented Interfaces:

Serializable, Comparable<TocMacroParameters.Scope>

Enclosing class:

TocMacroParameters

public static enum TocMacroParameters.Scope
extends Enum<TocMacroParameters.Scope>

Version:

$Id: d9bd8987cc8b95fe524e56a0ee5cad9799a4a7f4 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL List section starting where macro block is located in the XDOM.
PAGE List the sections of the whole page.

Method Summary

Methods

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

LOCAL

public static final TocMacroParameters.Scope LOCAL

List section starting where macro block is located in the XDOM.

PAGE

public static final TocMacroParameters.Scope PAGE

List the sections of the whole page.

Method Detail

values

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

Returns:

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

valueOf

public static TocMacroParameters.Scope 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