de.weltraumschaf.commons.uri

Class Link

java.lang.Object

de.weltraumschaf.commons.uri.Link

abstract class Link
extends Object

Class representing hypermedia links.

A hypermedia link may include additional parameters beyond its underlying URI. Parameters such as rel or type provide additional meta-data. Links in responses can be followed by creating an javax.ws.rs.client.Invocation.Builder or a javax.ws.rs.client.WebTarget.

The methods #toString() and #valueOf can be used to serialize and de-serialize a link into a link header (RFC 5988).

Since:

2.0

Author:

Marek Potociar, Santiago Pericas-Geertsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Link.Builder Builder class for hypermedia links.
static class	Link.JaxbLink Value type for javax.ws.rs.core.Link that can be marshalled and unmarshalled by JAXB.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REL Rel link param from RFC 5988.
static String	TITLE Title link param from RFC 5988.
static String	TYPE Type link param from RFC 5988.

Constructor Summary

Constructors

Constructor and Description
Link()

Method Summary

Modifier and Type	Method and Description
abstract Map<String,String>	getParams() Returns an immutable map that includes all the link parameters defined on this link.
abstract String	getRel() Returns the value associated with the link rel param, or null if this param is not specified.
abstract List<String>	getRels() Returns the value associated with the link rel param as a list of strings or the empty list if rel is not defined.
abstract String	getTitle() Returns the value associated with the link title param, or null if this param is not specified.
abstract String	getType() Returns the value associated with the link type param, or null if this param is not specified.
abstract URI	getUri() Returns the underlying URI associated with this link.
abstract BaseUriBuilder	getUriBuilder() Convenience method that returns a javax.ws.rs.core.UriBuilder initialized with this link's underlying URI.
abstract String	toString() Returns a string representation as a link header (RFC 5988).

Methods inherited from class java.lang.Object

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

Field Detail

TITLE

public static final String TITLE

Title link param from RFC 5988.

See Also:

Constant Field Values

REL

public static final String REL

Rel link param from RFC 5988.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type link param from RFC 5988.

See Also:

Constant Field Values

Constructor Detail

Link

Link()

Method Detail

getUri

public abstract URI getUri()

Returns the underlying URI associated with this link.

Returns:

underlying URI.

getUriBuilder

public abstract BaseUriBuilder getUriBuilder()

Convenience method that returns a javax.ws.rs.core.UriBuilder initialized with this link's underlying URI.

Returns:

BaseUriBuilder initialized using underlying URI.

getRel

public abstract String getRel()

Returns the value associated with the link rel param, or null if this param is not specified.

Returns:

relation types as string or null.

getRels

public abstract List<String> getRels()

Returns the value associated with the link rel param as a list of strings or the empty list if rel is not defined.

Returns:

relation types as list of strings or empty list.

getTitle

public abstract String getTitle()

Returns the value associated with the link title param, or null if this param is not specified.

Returns:

value of title parameter or null.

getType

public abstract String getType()

Returns the value associated with the link type param, or null if this param is not specified.

Returns:

value of type parameter or null.

getParams

public abstract Map<String,String> getParams()

Returns an immutable map that includes all the link parameters defined on this link. If defined, this map will include entries for rel, title and type.

Returns:

immutable map of link parameters.

toString

public abstract String toString()

Returns a string representation as a link header (RFC 5988). All link params are serialized as link-param="value" where value is a quoted-string. For example, <http://foo.bar/employee/john>; title="employee"; rel="manager friend"

Overrides:

toString in class Object