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
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 ConstantDescriptionDeprecated.since 1.4.Deprecated.since 1.4, useSIMPLE
instead.Deprecated.since 1.4, usePATH_SEGMENT
instead. -
Method Summary
Modifier and TypeMethodDescriptionReturns theTemplateVariable.VariableType
for the given variable key.boolean
Returns whether the variable of this type is optional.toString()
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.
-
Enum Constant Details
-
SIMPLE
-
PATH_VARIABLE
Deprecated.since 1.4, useSIMPLE
instead. -
RESERVED_STRING
-
DOT
-
REQUEST_PARAM
-
REQUEST_PARAM_CONTINUED
-
PATH_SEGMENT
-
SEGMENT
Deprecated.since 1.4, usePATH_SEGMENT
instead. -
PATH_STYLE_PARAMETER
-
FRAGMENT
-
COMPOSITE_PARAM
Deprecated.since 1.4. Use the actual type and callTemplateVariable.composite()
.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
encode
-
isOptional
public boolean isOptional()Returns whether the variable of this type is optional.- Returns:
-
from
Returns theTemplateVariable.VariableType
for the given variable key.- Parameters:
key
- must not be null.- Returns:
-
toString
- Overrides:
toString
in classEnum<TemplateVariable.VariableType>
-