org.apache.shindig.gadgets.variables

Enum Substitutions.Type

java.lang.Object

java.lang.Enum<Substitutions.Type>

org.apache.shindig.gadgets.variables.Substitutions.Type

All Implemented Interfaces:

Serializable, Comparable<Substitutions.Type>

Enclosing class:

Substitutions

public static enum Substitutions.Type
extends Enum<Substitutions.Type>

Defines all of the valid types of message substitutions. NOTE: Order is critical here, since substitutions are only recursive on nodes with lower order this is to prevent infinite recursion in substitution logic.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIDI Bi-directional text transformations.
MESSAGE Localization strings.
MODULE MODULE_ variables (i.e.
USER_PREF User preferences.

Method Summary

Methods

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

MESSAGE

public static final Substitutions.Type MESSAGE

Localization strings.

USER_PREF

public static final Substitutions.Type USER_PREF

User preferences.

MODULE

public static final Substitutions.Type MODULE

MODULE_ variables (i.e. MODULE_ID)

BIDI

public static final Substitutions.Type BIDI

Bi-directional text transformations.

Method Detail

values

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

Returns:

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

valueOf

public static Substitutions.Type 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