org.xwiki.rendering.macro.include

Enum IncludeMacroParameters.Context

java.lang.Object

java.lang.Enum<IncludeMacroParameters.Context>

org.xwiki.rendering.macro.include.IncludeMacroParameters.Context

All Implemented Interfaces:

Serializable, Comparable<IncludeMacroParameters.Context>

Enclosing class:

IncludeMacroParameters

public static enum IncludeMacroParameters.Context
extends Enum<IncludeMacroParameters.Context>

Version:

$Id: 69c0119e294f85e15c364cb4bcf9f0f11f9fa192 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT Macro executed in the context of the current page.
NEW Macro executed in its own context.

Method Summary

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

NEW

public static final IncludeMacroParameters.Context NEW

Macro executed in its own context.

CURRENT

public static final IncludeMacroParameters.Context CURRENT

Macro executed in the context of the current page.

Method Detail

values

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

Returns:

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

valueOf

public static IncludeMacroParameters.Context 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