io.micronaut.http.hateoas

Interface Link

All Known Implementing Classes:

DefaultLink

public interface Link

Interface for a hateoas link.

See https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5

Since:

1.1

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Link.Builder Build for creating Link instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.CharSequence	ABOUT About link.
static java.lang.CharSequence	HELP Help link.
static java.lang.CharSequence	HREF Href link.
static java.lang.CharSequence	SELF Self link.

Method Summary

Modifier and Type	Method and Description
static Link.Builder	build(java.lang.String uri) Create a link from the given URI.
static Link.Builder	build(java.net.URI uri) Create a link from the given URI.
default java.util.Optional<java.lang.String>	getDeprecation()
java.lang.String	getHref()
default java.util.Optional<java.lang.String>	getHreflang()
default java.util.Optional<java.lang.String>	getName()
default java.util.Optional<java.lang.String>	getProfile()
default java.util.Optional<java.lang.String>	getTitle()
default java.util.Optional<MediaType>	getType()
default boolean	isTemplated()
static Link	of(java.lang.String uri) Create a link from the given URI.
static Link	of(java.net.URI uri) Create a link from the given URI.

Field Detail

HELP

static final java.lang.CharSequence HELP

Help link.

SELF

static final java.lang.CharSequence SELF

Self link.

ABOUT

static final java.lang.CharSequence ABOUT

About link.

HREF

static final java.lang.CharSequence HREF

Href link.

Method Detail

getHref

java.lang.String getHref()

Returns:

The URI to template to

isTemplated

default boolean isTemplated()

Returns:

Whether the URI is templated

getType

default java.util.Optional<MediaType> getType()

Returns:

The type of the URI

getDeprecation

default java.util.Optional<java.lang.String> getDeprecation()

Returns:

The deprecation URI

getProfile

default java.util.Optional<java.lang.String> getProfile()

Returns:

The profile URI

getName

default java.util.Optional<java.lang.String> getName()

Returns:

The name of the link

getTitle

default java.util.Optional<java.lang.String> getTitle()

Returns:

The title of the link

getHreflang

default java.util.Optional<java.lang.String> getHreflang()

Returns:

The language of the link

of

static Link of(java.net.URI uri)

Create a link from the given URI.

Parameters:

uri - The URI

Returns:

The link

of

static Link of(java.lang.String uri)

Create a link from the given URI.

Parameters:

uri - The URI

Returns:

The link

build

static Link.Builder build(java.net.URI uri)

Create a link from the given URI.

Parameters:

uri - The URI

Returns:

The link

build

static Link.Builder build(java.lang.String uri)

Create a link from the given URI.

Parameters:

uri - The URI

Returns:

The link