org.springframework.hateoas

Interface LinkDiscoverer

All Superinterfaces:

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

All Known Implementing Classes:

AlpsLinkDiscoverer, HalLinkDiscoverer, JsonPathLinkDiscoverer

public interface LinkDiscoverer
extends org.springframework.plugin.core.Plugin<MediaType>

Interface to allow discovering links by relation type from some source.

Author:

Oliver Gierke

Method Summary

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

Methods inherited from interface org.springframework.plugin.core.Plugin

supports

Method Detail

findLinkWithRel

Link findLinkWithRel(String rel,
                     String representation)

Finds a single link with the given relation type in the given String representation.

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

the first link with the given relation type found, or null if none was found.

findLinkWithRel

Link findLinkWithRel(String rel,
                     InputStream representation)

Finds a single link with the given relation type in the given InputStream representation.

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

the first link with the given relation type found, or null if none was found.

findLinksWithRel

List<Link> findLinksWithRel(String rel,
                            String representation)

Returns all links with the given relation type found in the given String representation.

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

findLinksWithRel

List<Link> findLinksWithRel(String rel,
                            InputStream representation)

Returns all links with the given relation type found in the given InputStream representation.

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns: