Package org.springframework.hateoas

Enum Class TemplateVariable.VariableType

java.lang.Object

java.lang.Enum<TemplateVariable.VariableType>

org.springframework.hateoas.TemplateVariable.VariableType

All Implemented Interfaces:

Serializable, Comparable<TemplateVariable.VariableType>, Constable

Enclosing class:

TemplateVariable

public static enum TemplateVariable.VariableType
extends Enum<TemplateVariable.VariableType>

An enumeration for all supported variable types.

Author:

Oliver Gierke

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPOSITE_PARAM	Deprecated. since 1.4.
DOT
FRAGMENT
PATH_SEGMENT
PATH_STYLE_PARAMETER
PATH_VARIABLE	Deprecated. since 1.4, use SIMPLE instead.
REQUEST_PARAM
REQUEST_PARAM_CONTINUED
RESERVED_STRING
SEGMENT	Deprecated. since 1.4, use PATH_SEGMENT instead.
SIMPLE

Method Summary

Modifier and Type	Method	Description
String	encode(String value)
static TemplateVariable.VariableType	from(String key)	Returns the TemplateVariable.VariableType for the given variable key.
boolean	isOptional()	Returns whether the variable of this type is optional.
String	toString()
static TemplateVariable.VariableType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TemplateVariable.VariableType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SIMPLE

public static final TemplateVariable.VariableType SIMPLE

PATH_VARIABLE

@Deprecated
public static final TemplateVariable.VariableType PATH_VARIABLE

Deprecated.

since 1.4, use SIMPLE instead.

RESERVED_STRING

public static final TemplateVariable.VariableType RESERVED_STRING

DOT

public static final TemplateVariable.VariableType DOT

REQUEST_PARAM

public static final TemplateVariable.VariableType REQUEST_PARAM

REQUEST_PARAM_CONTINUED

public static final TemplateVariable.VariableType REQUEST_PARAM_CONTINUED

PATH_SEGMENT

public static final TemplateVariable.VariableType PATH_SEGMENT

SEGMENT

@Deprecated
public static final TemplateVariable.VariableType SEGMENT

Deprecated.

since 1.4, use PATH_SEGMENT instead.

PATH_STYLE_PARAMETER

public static final TemplateVariable.VariableType PATH_STYLE_PARAMETER

FRAGMENT

public static final TemplateVariable.VariableType FRAGMENT

COMPOSITE_PARAM

public static final TemplateVariable.VariableType COMPOSITE_PARAM

Deprecated.

since 1.4. Use the actual type and call TemplateVariable.composite().

Method Details

values

public static TemplateVariable.VariableType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TemplateVariable.VariableType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

encode

public String encode(String value)

isOptional

public boolean isOptional()

Returns whether the variable of this type is optional.

Returns:

from

public static TemplateVariable.VariableType from(String key)

Returns the TemplateVariable.VariableType for the given variable key.

Parameters:

key - must not be null.

Returns:

toString

public String toString()

Overrides:

toString in class Enum<TemplateVariable.VariableType>