org.springframework.hateoas.mediatype.hal

Interface CurieProvider

All Known Implementing Classes:

DefaultCurieProvider

public interface CurieProvider

API to provide HAL curie information for links.

Since:

0.9

Author:

Oliver Gierke, Jeff Stano

See Also:

https://tools.ietf.org/html/draft-kelly-json-hal#section-8.2}

Field Summary

Fields

Modifier and Type	Field and Description
static CurieProvider	NONE

Method Summary

Modifier and Type	Method and Description
Collection<?>	getCurieInformation(Links links) Returns an object to render as the base curie information.
HalLinkRelation	getNamespacedRelFor(LinkRelation rel) Returns the rel to be rendered for the given rel.
HalLinkRelation	getNamespacedRelFrom(Link link) Returns the rel to be rendered for the given Link.

Field Detail

NONE

static final CurieProvider NONE

Method Detail

getNamespacedRelFrom

HalLinkRelation getNamespacedRelFrom(Link link)

Returns the rel to be rendered for the given Link. Will potentially prefix the rel but also might decide not to, depending on the actual rel.

Parameters:

link -

Returns:

getNamespacedRelFor

HalLinkRelation getNamespacedRelFor(LinkRelation rel)

Returns the rel to be rendered for the given rel. Will potentially prefix the rel but also might decide not to, depending on the actual rel.

Parameters:

rel -

Returns:

Since:

0.17

getCurieInformation

Collection<?> getCurieInformation(Links links)

Returns an object to render as the base curie information. Implementations have to make sure, the returned instances renders as defined in the spec.

Parameters:

links - the Links that have been added to the response so far.

Returns:

must not be null.