org.springframework.hateoas.mediatype.collectionjson

Class CollectionJsonLinkDiscoverer

java.lang.Object

org.springframework.hateoas.client.JsonPathLinkDiscoverer

org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer

All Implemented Interfaces:

LinkDiscoverer, org.springframework.plugin.core.Plugin<MediaType>

public class CollectionJsonLinkDiscoverer
extends JsonPathLinkDiscoverer

LinkDiscoverer implementation based on JSON Collection link structure. NOTE: Since links can appear in two different places in a Collection+JSON document, this discoverer uses two.

Author:

Greg Turnquist, Oliver Drotbohm

Constructor Summary

Constructors

Constructor and Description
CollectionJsonLinkDiscoverer()

Method Summary

Modifier and Type	Method and Description
Links	findLinksWithRel(LinkRelation relation, InputStream representation) Returns all links with the given LinkRelation found in the given InputStream representation.
Links	findLinksWithRel(LinkRelation relation, String representation) Returns all links with the given LinkRelation found in the given String representation.
Optional<Link>	findLinkWithRel(LinkRelation relation, InputStream representation) Finds a single link with the given LinkRelation in the given InputStream representation.
Optional<Link>	findLinkWithRel(LinkRelation relation, String representation) Finds a single link with the given LinkRelation in the given String representation.

Methods inherited from class org.springframework.hateoas.client.JsonPathLinkDiscoverer

extractLink, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.client.LinkDiscoverer

findLinksWithRel, findLinksWithRel, findLinkWithRel, findLinkWithRel, findRequiredLinkWithRel, findRequiredLinkWithRel

Constructor Detail

CollectionJsonLinkDiscoverer

public CollectionJsonLinkDiscoverer()

Method Detail

findLinkWithRel

public Optional<Link> findLinkWithRel(LinkRelation relation,
                                      String representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given LinkRelation in the given String representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Overrides:

findLinkWithRel in class JsonPathLinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

the first link with the given relation type found, or Optional.empty() if none was found.

findLinkWithRel

public Optional<Link> findLinkWithRel(LinkRelation relation,
                                      InputStream representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given LinkRelation in the given InputStream representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Overrides:

findLinkWithRel in class JsonPathLinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

the first Link with the given LinkRelation found, or Optional.empty() if none was found.

findLinksWithRel

public Links findLinksWithRel(LinkRelation relation,
                              String representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given LinkRelation found in the given String representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Overrides:

findLinksWithRel in class JsonPathLinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

will never be null.

findLinksWithRel

public Links findLinksWithRel(LinkRelation relation,
                              InputStream representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given LinkRelation found in the given InputStream representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Overrides:

findLinksWithRel in class JsonPathLinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

will never be null.