org.weborganic.furi
Enum Variable.Modifier

java.lang.Object
  extended by java.lang.Enum<Variable.Modifier>
      extended by org.weborganic.furi.Variable.Modifier
All Implemented Interfaces:
Serializable, Comparable<Variable.Modifier>
Enclosing class:
Variable

public static enum Variable.Modifier
extends Enum<Variable.Modifier>

Indicate that the variable's value should be processed as a list ("@") or an associative array ("%"). This variable type is an instruction for the template processor. It is not an indication of language or implementation type.


Enum Constant Summary
REMAINDER
          Indicate that this variable can be expanded as a list of strings.
SUBSTRING
          Indicate that this variable can be expanded as a simple string (default).
 
Method Summary
static Variable.Modifier valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Variable.Modifier[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SUBSTRING

public static final Variable.Modifier SUBSTRING
Indicate that this variable can be expanded as a simple string (default).


REMAINDER

public static final Variable.Modifier REMAINDER
Indicate that this variable can be expanded as a list of strings.

Method Detail

values

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

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

valueOf

public static Variable.Modifier 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