com.github.fge.uritemplate.vars.specs

Enum VariableSpecType

java.lang.Object

java.lang.Enum<VariableSpecType>

com.github.fge.uritemplate.vars.specs.VariableSpecType

All Implemented Interfaces:

Serializable, Comparable<VariableSpecType>

public enum VariableSpecType
extends Enum<VariableSpecType>

Enumeration of a variable modifier type

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPLODED Explode modifier (*)
PREFIX Prefix modifier (:xxx where xxx is an integer)
SIMPLE No modifier

Method Summary

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

SIMPLE

public static final VariableSpecType SIMPLE

No modifier

PREFIX

public static final VariableSpecType PREFIX

Prefix modifier (:xxx where xxx is an integer)

Only makes sense for string values.

EXPLODED

public static final VariableSpecType EXPLODED

Explode modifier (*)

Only makes sense for list and map values.

Method Detail

values

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

Returns:

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

valueOf

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