Package org.springframework.restdocs.hypermedia

Class LinkDescriptor

java.lang.Object

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

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

org.springframework.restdocs.hypermedia.LinkDescriptor

public class LinkDescriptor
extends IgnorableDescriptor<LinkDescriptor>

A description of a link found in a hypermedia API.

Author:

Andy Wilkinson

See Also:

• HypermediaDocumentation.linkWithRel(String)

Constructor Summary

Constructors

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

Method Summary

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

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

ignored, isIgnored

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

attributes, description, getAttributes, getDescription

Methods inherited from class java.lang.Object

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

Constructor Details

LinkDescriptor

protected LinkDescriptor(String rel)

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

Parameters:

rel - the rel of the link

Method Details

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

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