org.springframework.restdocs.hypermedia

Class LinkExtractors

java.lang.Object

org.springframework.restdocs.hypermedia.LinkExtractors

public abstract class LinkExtractors
extends Object

Static factory methods providing a selection of link extractors for use when documentating a hypermedia-based API.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static LinkExtractor	atomLinks() Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.
static LinkExtractor	extractorForContentType(String contentType) Returns the LinkExtractor for the given contentType or null if there is no extractor for the content type.
static LinkExtractor	halLinks() Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.

Methods inherited from class java.lang.Object

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

Method Detail

halLinks

public static LinkExtractor halLinks()

Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.

Returns:

The extract for HAL-style links

atomLinks

public static LinkExtractor atomLinks()

Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.

Returns:

The extractor for Atom-style links

extractorForContentType

public static LinkExtractor extractorForContentType(String contentType)

Returns the LinkExtractor for the given contentType or null if there is no extractor for the content type.

Parameters:

contentType - The content type, may include parameters

Returns:

The extractor for the content type, or null