Package com.xwiki.commons.document

Enum MacroBlockFinder.Lookup

java.lang.Object

java.lang.Enum<MacroBlockFinder.Lookup>

com.xwiki.commons.document.MacroBlockFinder.Lookup

All Implemented Interfaces:

Serializable, Comparable<MacroBlockFinder.Lookup>

Enclosing interface:

MacroBlockFinder

public static enum MacroBlockFinder.Lookup
extends Enum<MacroBlockFinder.Lookup>

An enum defining the actions to be done after finding a macro in the XDOM.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BREAK	The lookup for other macros should halt.
CONTINUE	The lookup for other macros can continue while also parsing the content of the processed macro.
SKIP	The lookup for other macros can continue without parsing the content of the processed macro.

Method Summary

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

BREAK

public static final MacroBlockFinder.Lookup BREAK

The lookup for other macros should halt.

SKIP

public static final MacroBlockFinder.Lookup SKIP

The lookup for other macros can continue without parsing the content of the processed macro.

CONTINUE

public static final MacroBlockFinder.Lookup CONTINUE

The lookup for other macros can continue while also parsing the content of the processed macro.

Method Detail

values

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

Returns:

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

valueOf

public static MacroBlockFinder.Lookup 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