org.springframework.hateoas

Class Link

java.lang.Object

org.springframework.hateoas.Link

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DefaultCurieProvider.Curie, LinkMixin

public class Link
extends Object
implements Serializable

Value object for links.

Author:

Oliver Gierke, Greg Turnquist, Jens Schauder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATOM_NAMESPACE
static LinkRelation	REL_FIRST Deprecated. Use IanaLinkRelations.FIRST instead.
static LinkRelation	REL_LAST Deprecated. Use IanaLinkRelations.LAST instead.
static LinkRelation	REL_NEXT Deprecated. Use IanaLinkRelations.NEXT instead.
static LinkRelation	REL_PREVIOUS Deprecated. Use IanaLinkRelations.PREV instead.
static LinkRelation	REL_SELF Deprecated. Use IanaLinkRelations.SELF instead.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Link() Empty constructor required by the marshaling framework.
	Link(String href) Creates a new link to the given URI with the self rel.
	Link(String href, LinkRelation rel) Creates a new Link to the given URI with the given rel.
	Link(String href, String rel) Creates a new Link to the given URI with the given rel.
	Link(UriTemplate template, LinkRelation rel) Creates a new Link from the given UriTemplate and rel.
	Link(UriTemplate template, String rel) Creates a new Link from the given UriTemplate and rel.

Method Summary

Modifier and Type	Method and Description
Link	andAffordance(Affordance affordance) Create new Link with an additional Affordance.
Link	andAffordance(org.springframework.http.HttpMethod httpMethod, Class<?> inputType, List<QueryParameter> queryMethodParameters, Class<?> outputType) Convenience method when chaining an existing Link.
Link	andAffordance(org.springframework.http.HttpMethod httpMethod, org.springframework.core.ResolvableType inputType, List<QueryParameter> queryMethodParameters, org.springframework.core.ResolvableType outputType) Convenience method when chaining an existing Link.
Link	andAffordance(String name, org.springframework.http.HttpMethod httpMethod, org.springframework.core.ResolvableType inputType, List<QueryParameter> queryMethodParameters, org.springframework.core.ResolvableType outputType) Convenience method when chaining an existing Link.
Link	andAffordances(List<Affordance> affordances) Create new Link with additional Affordances.
Link	expand(Map<String,? extends Object> arguments) Turns the current template into a Link by expanding it using the given parameters.
Link	expand(Object... arguments) Turns the current template into a Link by expanding it using the given parameters.
List<Affordance>	getAffordances() Returns safe copy of Affordances.
List<String>	getVariableNames() Returns the variable names contained in the template.
List<TemplateVariable>	getVariables() Returns all TemplateVariables contained in the Link.
boolean	hasRel(LinkRelation rel) Returns whether the Link has the given LinkRelation.
boolean	hasRel(String rel) Returns whether the current Link has the given link relation.
boolean	isTemplated() Returns whether or not the link is templated.
String	toString()
URI	toUri() Returns the current href as URI after expanding the links without any arguments, i.e. all optional URI TemplateVariables will be dropped.
static Link	valueOf(String element) Factory method to easily create Link instances from RFC-5988 compatible String representations of a link.
Link	withAffordances(List<Affordance> affordances) Creats a new Link with the given Affordances.
Link	withRel(LinkRelation relation) Creates a new Link with the same href but given LinkRelation.
Link	withRel(String relation) Creates a new Link with the same href but given LinkRelation.
Link	withSelfRel() Returns a Link pointing to the same URI but with the self relation.

Methods inherited from class java.lang.Object

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

Field Detail

ATOM_NAMESPACE

public static final String ATOM_NAMESPACE

See Also:

Constant Field Values

REL_SELF

@Deprecated
public static final LinkRelation REL_SELF

Deprecated. Use IanaLinkRelations.SELF instead.

REL_FIRST

@Deprecated
public static final LinkRelation REL_FIRST

Deprecated. Use IanaLinkRelations.FIRST instead.

REL_PREVIOUS

@Deprecated
public static final LinkRelation REL_PREVIOUS

Deprecated. Use IanaLinkRelations.PREV instead.

REL_NEXT

@Deprecated
public static final LinkRelation REL_NEXT

Deprecated. Use IanaLinkRelations.NEXT instead.

REL_LAST

@Deprecated
public static final LinkRelation REL_LAST

Deprecated. Use IanaLinkRelations.LAST instead.

Constructor Detail

Link

public Link(String href)

Creates a new link to the given URI with the self rel.

Parameters:

href - must not be null or empty.

See Also:

IanaLinkRelations.SELF

Link

public Link(String href,
            String rel)

Creates a new Link to the given URI with the given rel.

Parameters:

href - must not be null or empty.

rel - must not be null or empty.

Link

public Link(String href,
            LinkRelation rel)

Creates a new Link to the given URI with the given rel.

Parameters:

href - must not be null or empty.

rel - must not be null or empty.

Link

public Link(UriTemplate template,
            String rel)

Creates a new Link from the given UriTemplate and rel.

Parameters:

template - must not be null.

rel - must not be null or empty.

Link

public Link(UriTemplate template,
            LinkRelation rel)

Creates a new Link from the given UriTemplate and rel.

Parameters:

template - must not be null.

rel - must not be null or empty.

Link

protected Link()

Empty constructor required by the marshaling framework.

Method Detail

getAffordances

public List<Affordance> getAffordances()

Returns safe copy of Affordances.

Returns:

withSelfRel

public Link withSelfRel()

Returns a Link pointing to the same URI but with the self relation.

Returns:

andAffordance

public Link andAffordance(Affordance affordance)

Create new Link with an additional Affordance.

Parameters:

affordance - must not be null.

Returns:

andAffordance

public Link andAffordance(String name,
                          org.springframework.http.HttpMethod httpMethod,
                          org.springframework.core.ResolvableType inputType,
                          List<QueryParameter> queryMethodParameters,
                          org.springframework.core.ResolvableType outputType)

Convenience method when chaining an existing Link.

Parameters:

name -

httpMethod -

inputType -

queryMethodParameters -

outputType -

Returns:

andAffordance

public Link andAffordance(org.springframework.http.HttpMethod httpMethod,
                          org.springframework.core.ResolvableType inputType,
                          List<QueryParameter> queryMethodParameters,
                          org.springframework.core.ResolvableType outputType)

Convenience method when chaining an existing Link. Defaults the name of the affordance to verb + classname, e.g. <httpMethod=HttpMethod.PUT, inputType=Employee> produces <name=putEmployee>.

Parameters:

httpMethod -

inputType -

queryMethodParameters -

outputType -

Returns:

andAffordance

public Link andAffordance(org.springframework.http.HttpMethod httpMethod,
                          Class<?> inputType,
                          List<QueryParameter> queryMethodParameters,
                          Class<?> outputType)

Convenience method when chaining an existing Link. Defaults the name of the affordance to verb + classname, e.g. <httpMethod=HttpMethod.PUT, inputType=Employee> produces <name=putEmployee>.

Parameters:

httpMethod -

inputType -

queryMethodParameters -

outputType -

Returns:

andAffordances

public Link andAffordances(List<Affordance> affordances)

Create new Link with additional Affordances.

Parameters:

affordances - must not be null.

Returns:

withAffordances

public Link withAffordances(List<Affordance> affordances)

Creats a new Link with the given Affordances.

Parameters:

affordances - must not be null.

Returns:

getVariableNames

public List<String> getVariableNames()

Returns the variable names contained in the template.

Returns:

getVariables

public List<TemplateVariable> getVariables()

Returns all TemplateVariables contained in the Link.

Returns:

isTemplated

public boolean isTemplated()

Returns whether or not the link is templated.

Returns:

expand

public Link expand(Object... arguments)

Turns the current template into a Link by expanding it using the given parameters.

Parameters:

arguments -

Returns:

expand

public Link expand(Map<String,? extends Object> arguments)

Turns the current template into a Link by expanding it using the given parameters.

Parameters:

arguments - must not be null.

Returns:

withRel

public Link withRel(LinkRelation relation)

Creates a new Link with the same href but given LinkRelation.

Parameters:

relation - must not be null.

Returns:

withRel

public Link withRel(String relation)

Creates a new Link with the same href but given LinkRelation.

Parameters:

relation - must not be null or empty.

Returns:

hasRel

public boolean hasRel(String rel)

Returns whether the current Link has the given link relation.

Parameters:

rel - must not be null or empty.

Returns:

hasRel

public boolean hasRel(LinkRelation rel)

Returns whether the Link has the given LinkRelation.

Parameters:

rel - must not be null.

Returns:

toUri

public URI toUri()

Returns the current href as URI after expanding the links without any arguments, i.e. all optional URI TemplateVariables will be dropped. If the href contains mandatory TemplateVariables, the URI creation will fail with an IllegalStateException.

Returns:

will never be null.

Throws:

IllegalStateException - in case the href contains mandatory URI TemplateVariables.

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static Link valueOf(String element)

Factory method to easily create Link instances from RFC-5988 compatible String representations of a link. Will return null if input String is either empty or null.

Parameters:

element - an RFC-5899 compatible representation of a link.

Returns:

Throws:

IllegalArgumentException - if a non-empty String was given that does not adhere to RFC-5899.

IllegalArgumentException - if no rel attribute could be found.