org.sweble.wikitext.engine

Enum PfnArgumentMode

java.lang.Object

java.lang.Enum<PfnArgumentMode>

org.sweble.wikitext.engine.PfnArgumentMode

All Implemented Interfaces:

Serializable, Comparable<PfnArgumentMode>

public enum PfnArgumentMode
extends Enum<PfnArgumentMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPANDED_AND_TRIMMED_VALUES The original template arguments will be collapsed as is done by UNEXPANDED_VALUES.
TEMPLATE_ARGUMENTS The original template arguments are left as is.
UNEXPANDED_VALUES This is the normal mode.

Method Summary

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

UNEXPANDED_VALUES

public static final PfnArgumentMode UNEXPANDED_VALUES

This is the normal mode. The original template arguments (name, value) will be collapsed into a single value of the form "$name=$value". No expansion is done.

EXPANDED_AND_TRIMMED_VALUES

public static final PfnArgumentMode EXPANDED_AND_TRIMMED_VALUES

The original template arguments will be collapsed as is done by UNEXPANDED_VALUES. Then the collapsed value is expanded and trimmed.

TEMPLATE_ARGUMENTS

public static final PfnArgumentMode TEMPLATE_ARGUMENTS

The original template arguments are left as is.

Method Detail

values

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

Returns:

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

valueOf

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