TemplateVariable (Spring HATEOAS 1.2.11 API)

java.lang.Object
- org.springframework.hateoas.TemplateVariable

All Implemented Interfaces:

Serializable
```
public final class TemplateVariable
extends Object
implements Serializable
```
A single template variable.

Author:

Oliver Gierke, JamesE Richardson

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TemplateVariable.VariableType
An enumeration for all supported variable types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TemplateVariable.VariableType` An enumeration for all supported variable types.

Constructor Summary

Constructors
Constructor and Description
`TemplateVariable(String name, TemplateVariable.VariableType type)` Creates a new `TemplateVariable` with the given name and type.
`TemplateVariable(String name, TemplateVariable.VariableType type, String description)` Creates a new `TemplateVariable` with the given name, type and description.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TemplateVariable`	`compositeParameter(String parameter)` Static helper to fashion `TemplateVariable.VariableType.COMPOSITE_PARAM` variables.
`boolean`	`equals(Object o)`
`static TemplateVariable`	`fragment(String fragment)` Static helper to fashion `TemplateVariable.VariableType.FRAGMENT` variables.
`String`	`getDescription()`
`String`	`getName()`
`TemplateVariable.VariableType`	`getType()`
`boolean`	`hasDescription()` Returns whether the variable has a description.
`int`	`hashCode()`
`static TemplateVariable`	`pathVariable(String variable)` Static helper to fashion `TemplateVariable.VariableType.PATH_VARIABLE` variables.
`static TemplateVariable`	`requestParameter(String parameter)` Static helper to fashion `TemplateVariable.VariableType.REQUEST_PARAM` variables.
`static TemplateVariable`	`requestParameterContinued(String parameter)` Static helper to fashion `TemplateVariable.VariableType.REQUEST_PARAM_CONTINUED` variables.
`static TemplateVariable`	`segment(String segment)` Static helper to fashion `TemplateVariable.VariableType.SEGMENT` variables.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TemplateVariable
```
public TemplateVariable(String name,
                        TemplateVariable.VariableType type)
```
    Creates a new TemplateVariable with the given name and type.
    
    Parameters:
    
    name - must not be null or empty.
    
    type - must not be null.
  - TemplateVariable
```
public TemplateVariable(String name,
                        TemplateVariable.VariableType type,
                        String description)
```
    Creates a new TemplateVariable with the given name, type and description.
    
    Parameters:
    
    name - must not be null or empty.
    
    type - must not be null.
    
    description - must not be null.
- Method Detail
  - pathVariable
```
public static TemplateVariable pathVariable(String variable)
```
    Static helper to fashion TemplateVariable.VariableType.PATH_VARIABLE variables.
    
    Parameters:
    
    variable - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - requestParameter
```
public static TemplateVariable requestParameter(String parameter)
```
    Static helper to fashion TemplateVariable.VariableType.REQUEST_PARAM variables.
    
    Parameters:
    
    parameter - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - requestParameterContinued
```
public static TemplateVariable requestParameterContinued(String parameter)
```
    Static helper to fashion TemplateVariable.VariableType.REQUEST_PARAM_CONTINUED variables.
    
    Parameters:
    
    parameter - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - segment
```
public static TemplateVariable segment(String segment)
```
    Static helper to fashion TemplateVariable.VariableType.SEGMENT variables.
    
    Parameters:
    
    segment - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - fragment
```
public static TemplateVariable fragment(String fragment)
```
    Static helper to fashion TemplateVariable.VariableType.FRAGMENT variables.
    
    Parameters:
    
    fragment - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - compositeParameter
```
public static TemplateVariable compositeParameter(String parameter)
```
    Static helper to fashion TemplateVariable.VariableType.COMPOSITE_PARAM variables.
    
    Parameters:
    
    parameter - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - hasDescription
```
public boolean hasDescription()
```
    Returns whether the variable has a description.
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getName
```
public String getName()
```
  - getType
```
public TemplateVariable.VariableType getType()
```
  - getDescription
```
public String getDescription()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class TemplateVariable

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateVariable

TemplateVariable

Method Detail

pathVariable

requestParameter

requestParameterContinued

segment

fragment

compositeParameter

hasDescription

toString

getName

getType

getDescription

equals

hashCode