com.databasesandlife.util

Enum DomVariableExpander.VariableSyntax

java.lang.Object

java.lang.Enum<DomVariableExpander.VariableSyntax>

com.databasesandlife.util.DomVariableExpander.VariableSyntax

All Implemented Interfaces:

Serializable, Comparable<DomVariableExpander.VariableSyntax>

Enclosing class:

DomVariableExpander

public static enum DomVariableExpander.VariableSyntax
extends Enum<DomVariableExpander.VariableSyntax>

Enum Constant Summary

Enum Constants

Enum Constant and Description
dollarOrDollarThenBraces Accepts variables like ${foo} or $foo
dollarThenBraces Accepts variables like ${foo} but NOT $foo.

Method Summary

Modifier and Type	Method and Description
abstract CharSequence	expand(Map<String,String> variables, CharSequence template)
static DomVariableExpander.VariableSyntax	valueOf(String name) Returns the enum constant of this type with the specified name.
static DomVariableExpander.VariableSyntax[]	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

dollarThenBraces

public static final DomVariableExpander.VariableSyntax dollarThenBraces

Accepts variables like ${foo} but NOT $foo.

dollarOrDollarThenBraces

public static final DomVariableExpander.VariableSyntax dollarOrDollarThenBraces

Accepts variables like ${foo} or $foo

Method Detail

values

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

Returns:

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

valueOf

public static DomVariableExpander.VariableSyntax 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

expand

public abstract CharSequence expand(Map<String,String> variables,
                                    CharSequence template)
                             throws DomVariableExpander.VariableNotFoundException

Throws:

DomVariableExpander.VariableNotFoundException