org.springframework.restdocs.hypermedia

Class LinkDescriptor

java.lang.Object

org.springframework.restdocs.hypermedia.LinkDescriptor

public class LinkDescriptor
extends Object

A description of a link found in a hypermedia API

Author:

Andy Wilkinson

See Also:

HypermediaDocumentation.linkWithRel(String)

Method Summary

Modifier and Type	Method and Description
LinkDescriptor	description(String description) Specifies the description of the link
LinkDescriptor	optional() Marks the link as optional

Methods inherited from class java.lang.Object

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

Method Detail

description

public LinkDescriptor description(String description)

Specifies the description of the link

Parameters:

description - The link's description

Returns:

this

optional

public LinkDescriptor optional()

Marks the link as optional

Returns:

this