io.micronaut.http.hateoas

Class DefaultLink

java.lang.Object

io.micronaut.http.hateoas.DefaultLink

All Implemented Interfaces:

Link, Link.Builder

@Introspected
public class DefaultLink
extends Object
implements Link, Link.Builder

Default implementation of Link.

Since:

1.1

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.http.hateoas.Link

Link.Builder

Field Summary

Fields inherited from interface io.micronaut.http.hateoas.Link

ABOUT, HELP, HREF, SELF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultLink(String uri)

Method Summary

Modifier and Type	Method and Description
Link	build() Build the link.
Link.Builder	deprecation(String deprecationURI)
Link.Builder	deprecation(URI deprecation)
Optional<String>	getDeprecation()
String	getHref()
Optional<String>	getHreflang()
Optional<String>	getName()
Optional<String>	getProfile()
Optional<String>	getTitle()
Optional<MediaType>	getType()
Link.Builder	hreflang(String hreflang)
boolean	isTemplated()
Link.Builder	name(String name)
Link.Builder	profile(String profileURI)
Link.Builder	profile(URI profile)
Link.Builder	templated(boolean templated)
Link.Builder	title(String title)
Link.Builder	type(MediaType mediaType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.hateoas.Link

build, build, of, of

Constructor Detail

DefaultLink

protected DefaultLink(String uri)

Parameters:

uri - The URI

Method Detail

getHref

public String getHref()

Specified by:

getHref in interface Link

Returns:

The URI to template to

templated

public Link.Builder templated(boolean templated)

Specified by:

templated in interface Link.Builder

Parameters:

templated - Whether the URI is templated

Returns:

The builder

See Also:

Link.isTemplated()

profile

public Link.Builder profile(URI profile)

Specified by:

profile in interface Link.Builder

Parameters:

profile - The profile URI

Returns:

The builder

See Also:

Link.getProfile()

deprecation

public Link.Builder deprecation(URI deprecation)

Specified by:

deprecation in interface Link.Builder

Parameters:

deprecation - The deprecation URI

Returns:

The builder

See Also:

Link.getDeprecation()

profile

public Link.Builder profile(@Nullable
                            String profileURI)

Specified by:

profile in interface Link.Builder

Parameters:

profileURI - The profile URI

Returns:

The builder

See Also:

Link.getProfile()

deprecation

public Link.Builder deprecation(@Nullable
                                String deprecationURI)

Specified by:

deprecation in interface Link.Builder

Parameters:

deprecationURI - The deprecation URI

Returns:

The builder

See Also:

Link.getDeprecation()

title

public Link.Builder title(String title)

Specified by:

title in interface Link.Builder

Parameters:

title - The title of the link

Returns:

The builder

See Also:

Link.getTitle()

name

public Link.Builder name(String name)

Specified by:

name in interface Link.Builder

Parameters:

name - The name of the link

Returns:

The builder

See Also:

Link.getName()

hreflang

public Link.Builder hreflang(String hreflang)

Specified by:

hreflang in interface Link.Builder

Parameters:

hreflang - The language of the link

Returns:

The builder

See Also:

Link.getHreflang()

type

public Link.Builder type(MediaType mediaType)

Specified by:

type in interface Link.Builder

Parameters:

mediaType - The type of the URI

Returns:

The builder

See Also:

Link.getType()

isTemplated

public boolean isTemplated()

Specified by:

isTemplated in interface Link

Returns:

Whether the URI is templated

getType

public Optional<MediaType> getType()

Specified by:

getType in interface Link

Returns:

The type of the URI

getDeprecation

public Optional<String> getDeprecation()

Specified by:

getDeprecation in interface Link

Returns:

The deprecation URI

getProfile

public Optional<String> getProfile()

Specified by:

getProfile in interface Link

Returns:

The profile URI

getName

public Optional<String> getName()

Specified by:

getName in interface Link

Returns:

The name of the link

getTitle

public Optional<String> getTitle()

Specified by:

getTitle in interface Link

Returns:

The title of the link

getHreflang

public Optional<String> getHreflang()

Specified by:

getHreflang in interface Link

Returns:

The language of the link

build

public Link build()

Description copied from interface: Link.Builder

Build the link.

Specified by:

build in interface Link.Builder

Returns:

The Link