TemplateVariable (Spring HATEOAS 1.4.0-SNAPSHOT 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.Cardinality` The cardinality of the `TemplateVariable`.
`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)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`asString()`
`TemplateVariable`	`composite()` Marks the current template variable as composite value.
`static TemplateVariable`	`compositeParameter(String parameter)` Deprecated. since 1.4, use actual parameter type and call `composite()` on the instance instead.
`boolean`	`equals(Object o)`
`String`	`expand(Map<String,?> parameters)`
`static TemplateVariable`	`fragment(String name)` Static helper to fashion `TemplateVariable.VariableType.FRAGMENT` variables.
`String`	`getDescription()`
`String`	`getName()`
`TemplateVariable.VariableType`	`getType()` Returns the type of the `TemplateVariable`.
`boolean`	`hasDescription()` Returns whether the variable has a description.
`int`	`hashCode()`
`boolean`	`isComposite()` Returns whether the current `TemplateVariable` is a composite one.
`boolean`	`isSingular()` Returns whether the current `TemplateVariable` is a singular one.
`TemplateVariable`	`limit(int limit)`
`static TemplateVariable`	`pathVariable(String variable)` Static helper to fashion `TemplateVariable.VariableType.PATH_VARIABLE` variables.
`String`	`prepareAndEncode(Object value)`
`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`	`reservedString(String name)`
`static TemplateVariable`	`segment(String segment)` Static helper to fashion `TemplateVariable.VariableType.SEGMENT` variables.
`TemplateVariable`	`singular()` Marks the current template variable as singular value.
`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)
```
- 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 name)
```
    Static helper to fashion TemplateVariable.VariableType.FRAGMENT variables.
    
    Parameters:
    
    name - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - reservedString
```
public static TemplateVariable reservedString(String name)
```
  - compositeParameter
```
@Deprecated
public static TemplateVariable compositeParameter(String parameter)
```
    Deprecated. since 1.4, use actual parameter type and call composite() on the instance instead.
    
    Static helper to fashion TemplateVariable.VariableType.COMPOSITE_PARAM variables.
    
    Parameters:
    
    parameter - must not be null or empty.
    
    Returns:
    
    Since:
    
    1.1
  - composite
```
public TemplateVariable composite()
```
    Marks the current template variable as composite value.
    
    Returns:
    
    Since:
    
    1.4
  - singular
```
public TemplateVariable singular()
```
    Marks the current template variable as singular value.
    
    Returns:
    
    Since:
    
    1.4
  - limit
```
public TemplateVariable limit(int limit)
```
  - isComposite
```
public boolean isComposite()
```
    Returns whether the current TemplateVariable is a composite one.
    
    Returns:
    
    Since:
    
    1.4
  - isSingular
```
public boolean isSingular()
```
    Returns whether the current TemplateVariable is a singular one.
    
    Returns:
    
    Since:
    
    1.4
  - hasDescription
```
public boolean hasDescription()
```
    Returns whether the variable has a description.
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asString
```
public String asString()
```
  - getName
```
public String getName()
```
  - getType
```
public TemplateVariable.VariableType getType()
```
    Returns the type of the TemplateVariable.
    
    Returns:
    
    will never be null.
  - getDescription
```
public String getDescription()
```
  - expand
```
@Nullable
public String expand(Map<String,?> parameters)
```
  - prepareAndEncode
```
@Nullable
public String prepareAndEncode(@Nullable
                                         Object value)
```
  - equals
```
public boolean equals(@Nullable
                      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

reservedString

compositeParameter

composite

singular

limit

isComposite

isSingular

hasDescription

toString

asString

getName

getType

getDescription

expand

prepareAndEncode

equals

hashCode