Package sonia.scm.api.v2.resources

Interface HalAppender

All Known Implementing Classes:

EdisonHalAppender

public interface HalAppender

The HalAppender can be used within an HalEnricher to append hateoas links to a json response.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HalAppender.LinkArrayBuilder	Builder for link arrays.

Method Summary

Modifier and Type	Method	Description
void	appendEmbedded(String rel, de.otto.edison.hal.HalRepresentation embeddedItem)	Appends one embedded object to the json response.
void	appendEmbedded(String rel, List<de.otto.edison.hal.HalRepresentation> embeddedItems)	Appends a list of embedded objects to the json response.
void	appendLink(String rel, String href)	Appends one link to the json response.
HalAppender.LinkArrayBuilder	linkArrayBuilder(String rel)	Returns a builder which is able to append an array of links to the resource.

Method Details

appendLink

void appendLink(String rel,
 String href)

Appends one link to the json response.

Parameters:

rel - name of relation

href - link uri

linkArrayBuilder

HalAppender.LinkArrayBuilder linkArrayBuilder(String rel)

Returns a builder which is able to append an array of links to the resource.

Parameters:

rel - name of link relation

Returns:

multi link builder

appendEmbedded

void appendEmbedded(String rel,
 de.otto.edison.hal.HalRepresentation embeddedItem)

Appends one embedded object to the json response.

Parameters:

rel - name of relation

embeddedItem - embedded object

appendEmbedded

void appendEmbedded(String rel,
 List<de.otto.edison.hal.HalRepresentation> embeddedItems)

Appends a list of embedded objects to the json response.

Parameters:

rel - name of relation

embeddedItems - embedded objects