org.springframework.restdocs.hypermedia

Class LinkDescriptor

java.lang.Object

org.springframework.restdocs.snippet.AbstractDescriptor<LinkDescriptor>

org.springframework.restdocs.hypermedia.LinkDescriptor

public class LinkDescriptor
extends AbstractDescriptor<LinkDescriptor>

A description of a link found in a hypermedia API

Author:

Andy Wilkinson

See Also:

HypermediaDocumentation.linkWithRel(String)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinkDescriptor(String rel) Creates a new LinkDescriptor describing a link with the given rel.

Method Summary

Modifier and Type	Method and Description
LinkDescriptor	description(String description) Specifies the description of the link
String	getDescription() Returns the description for the link
String	getRel() Returns the rel of the link described by this descriptor
boolean	isOptional() Returns true if the described link is optional, otherwise false
LinkDescriptor	optional() Marks the link as optional

Methods inherited from class org.springframework.restdocs.snippet.AbstractDescriptor

attributes, getAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkDescriptor

protected LinkDescriptor(String rel)

Creates a new LinkDescriptor describing a link with the given rel.

Parameters:

rel - the rel of the link

Method Detail

description

public final LinkDescriptor description(String description)

Specifies the description of the link

Parameters:

description - The link's description

Returns:

this

optional

public final LinkDescriptor optional()

Marks the link as optional

Returns:

this

getRel

public final String getRel()

Returns the rel of the link described by this descriptor

Returns:

the rel

getDescription

public final String getDescription()

Returns the description for the link

Returns:

the link description

isOptional

public final boolean isOptional()

Returns true if the described link is optional, otherwise false

Returns:

true if the described link is optional, otherwise false