io.spring.initializr.metadata

Class Link

java.lang.Object

io.spring.initializr.metadata.Link

public class Link
extends Object

Metadata for a link. Each link has a "relation" that potentially attaches a strong semantic to the nature of the link. The URI of the link itself can be templated by including variables in the form `{variableName}`.

An actual URI can be generated using expand, providing a mapping for those variables.

Author:

Dave Syer, Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
Link()

Method Summary

Modifier and Type	Method and Description
static Link	create(String rel, String href)
static Link	create(String rel, String href, boolean templated)
static Link	create(String rel, String href, String description)
URI	expand(Map<String,String> parameters) Expand the link using the specified parameters.
String	getDescription()
String	getHref()
String	getRel()
Set<String>	getTemplateVariables()
boolean	isTemplated()
void	resolve()
void	setDescription(String description)
void	setHref(String href)
void	setRel(String rel)
void	setTemplated(boolean templated)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Link

public Link()

Method Detail

getRel

public String getRel()

setRel

public void setRel(String rel)

isTemplated

public boolean isTemplated()

setTemplated

public void setTemplated(boolean templated)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getHref

public String getHref()

getTemplateVariables

public Set<String> getTemplateVariables()

setHref

public void setHref(String href)

resolve

public void resolve()

expand

public URI expand(Map<String,String> parameters)

Expand the link using the specified parameters.

Parameters:

parameters - the parameters value

Returns:

an URI where all variables have been expanded

create

public static Link create(String rel,
                          String href)

create

public static Link create(String rel,
                          String href,
                          String description)

create

public static Link create(String rel,
                          String href,
                          boolean templated)