org.springframework.restdocs.hypermedia

Class Link

java.lang.Object

org.springframework.restdocs.hypermedia.Link

public class Link
extends Object

Representation of a link used in a Hypermedia-based API.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
Link(String rel, String href) Creates a new Link with the given rel and href.
Link(String rel, String href, String title) Creates a new Link with the given rel, href, and title.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getHref() Returns the link's href.
String	getRel() Returns the link's rel.
String	getTitle() Returns the link's title, or null if it does not have a title.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Link

public Link(String rel,
            String href)

Creates a new Link with the given rel and href.

Parameters:

rel - The link's rel

href - The link's href

Link

public Link(String rel,
            String href,
            String title)

Creates a new Link with the given rel, href, and title.

Parameters:

rel - The link's rel

href - The link's href

title - The link's title

Method Detail

getRel

public String getRel()

Returns the link's rel.

Returns:

the link's rel

getHref

public String getHref()

Returns the link's href.

Returns:

the link's href

getTitle

public String getTitle()

Returns the link's title, or null if it does not have a title.

Returns:

the link's title or null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object