org.pageseeder.berlioz.furi

Enum Variable.Form

java.lang.Object

java.lang.Enum<Variable.Form>

org.pageseeder.berlioz.furi.Variable.Form

All Implemented Interfaces:

Serializable, Comparable<Variable.Form>

Enclosing class:

Variable

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

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

Enum Constants

Enum Constant and Description
LIST Indicate that this variable can be expanded as a list of strings.
MAP Indicates that this variable can be expanded as an associated array.
STRING Indicate that this variable can be expanded as a simple string (default).

Method Summary

Modifier and Type	Method and Description
protected static Variable.Form	getType(String exp) Returns the type of this variable from the specified expression.
static Variable.Form	valueOf(String name) Returns the enum constant of this type with the specified name.
static Variable.Form[]	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

STRING

public static final Variable.Form STRING

Indicate that this variable can be expanded as a simple string (default).

LIST

public static final Variable.Form LIST

Indicate that this variable can be expanded as a list of strings.

MAP

public static final Variable.Form MAP

Indicates that this variable can be expanded as an associated array.

Method Detail

values

public static Variable.Form[] 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.Form c : Variable.Form.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.Form 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

getType

protected static Variable.Form getType(String exp)

Returns the type of this variable from the specified expression.

This method does not return null

Parameters:

exp - The expression.

Returns:

The type of this expression.