org.springframework.hateoas

Class TemplateVariable

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.

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

Modifier and Type	Method and Description
boolean	hasDescription() Returns whether the variable has a description.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

hasDescription

public boolean hasDescription()

Returns whether the variable has a description.

Returns:

toString

public String toString()

Overrides:

toString in class Object