Package io.micronaut.http.hateoas
Interface Link
-
- All Known Implementing Classes:
DefaultLink
public interface LinkInterface for a hateoas link.
See https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5
- Since:
- 1.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceLink.BuilderBuild for creatingLinkinstances.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static Link.Builderbuild(java.lang.String uri)Create a link from the given URI.static Link.Builderbuild(java.net.URI uri)Create a link from the given URI.default java.util.Optional<java.lang.String>getDeprecation()java.lang.StringgetHref()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 booleanisTemplated()static Linkof(java.lang.String uri)Create a link from the given URI.static Linkof(java.net.URI uri)Create a link from the given URI.
-
-
-
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
-
-