Link (micronaut 1.1.4 API)

All Known Subinterfaces:

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.

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 CharSequence`	`ABOUT` About link.
`static CharSequence`	`HELP` Help link.
`static CharSequence`	`HREF` Href link.
`static CharSequence`	`SELF` Self link.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Link.Builder`	`build(URI uri)` Create a link from the given URI.
`default Optional<URI>`	`getDeprecation()`
`URI`	`getHref()`
`default Optional<String>`	`getHreflang()`
`default Optional<String>`	`getName()`
`default Optional<URI>`	`getProfile()`
`default Optional<String>`	`getTitle()`
`default Optional<MediaType>`	`getType()`
`default boolean`	`isTemplated()`
`static Link`	`of(String uri)` Create a link from the given URI.
`static Link`	`of(URI uri)` Create a link from the given URI.

- Field Detail
  - HELP
```
static final CharSequence HELP
```
    Help link.
  - SELF
```
static final CharSequence SELF
```
    Self link.
  - ABOUT
```
static final CharSequence ABOUT
```
    About link.
  - HREF
```
static final CharSequence HREF
```
    Href link.
- Method Detail
  - getHref
```
URI getHref()
```
    Returns:
    
    The URI to template to
  - isTemplated
```
default boolean isTemplated()
```
    Returns:
    
    Whether the URI is templated
  - getType
```
default Optional<MediaType> getType()
```
    Returns:
    
    The type of the URI
  - getDeprecation
```
default Optional<URI> getDeprecation()
```
    Returns:
    
    The deprecation URI
  - getProfile
```
default Optional<URI> getProfile()
```
    Returns:
    
    The profile URI
  - getName
```
default Optional<String> getName()
```
    Returns:
    
    The name of the link
  - getTitle
```
default Optional<String> getTitle()
```
    Returns:
    
    The title of the link
  - getHreflang
```
default Optional<String> getHreflang()
```
    Returns:
    
    The language of the link
  - of
```
static Link of(URI uri)
```
    Create a link from the given URI.
    
    Parameters:
    
    uri - The URI
    
    Returns:
    
    The link
  - of
```
static Link of(String uri)
```
    Create a link from the given URI.
    
    Parameters:
    
    uri - The URI
    
    Returns:
    
    The link
  - build
```
static Link.Builder build(URI uri)
```
    Create a link from the given URI.
    
    Parameters:
    
    uri - The URI
    
    Returns:
    
    The link

Interface Link

Nested Class Summary

Field Summary

Method Summary

Field Detail

HELP

SELF

ABOUT

HREF

Method Detail

getHref

isTemplated

getType

getDeprecation

getProfile

getName

getTitle

getHreflang

of

of

build