io.micronaut.http.hateoas

Interface Link.Builder

All Known Implementing Classes:

DefaultLink

Enclosing interface:

Link

public static interface Link.Builder

Build for creating Link instances.

Method Summary

Modifier and Type	Method and Description
Link	build() Build the link.
Link.Builder	deprecation(java.lang.String deprecationURI)
Link.Builder	deprecation(java.net.URI deprecation)
Link.Builder	hreflang(java.lang.String hreflang)
Link.Builder	name(java.lang.String name)
Link.Builder	profile(java.lang.String profileURI)
Link.Builder	profile(java.net.URI profile)
Link.Builder	templated(boolean templated)
Link.Builder	title(java.lang.String title)
Link.Builder	type(MediaType mediaType)

Method Detail

templated

Link.Builder templated(boolean templated)

Parameters:

templated - Whether the URI is templated

Returns:

The builder

See Also:

Link.isTemplated()

profile

Link.Builder profile(@Nullable
                     java.net.URI profile)

Parameters:

profile - The profile URI

Returns:

The builder

See Also:

Link.getProfile()

profile

Link.Builder profile(@Nullable
                     java.lang.String profileURI)

Parameters:

profileURI - The profile URI

Returns:

The builder

See Also:

Link.getProfile()

deprecation

Link.Builder deprecation(@Nullable
                         java.net.URI deprecation)

Parameters:

deprecation - The deprecation URI

Returns:

The builder

See Also:

Link.getDeprecation()

deprecation

Link.Builder deprecation(@Nullable
                         java.lang.String deprecationURI)

Parameters:

deprecationURI - The deprecation URI

Returns:

The builder

See Also:

Link.getDeprecation()

title

Link.Builder title(@Nullable
                   java.lang.String title)

Parameters:

title - The title of the link

Returns:

The builder

See Also:

Link.getTitle()

name

Link.Builder name(@Nullable
                  java.lang.String name)

Parameters:

name - The name of the link

Returns:

The builder

See Also:

Link.getName()

hreflang

Link.Builder hreflang(@Nullable
                      java.lang.String hreflang)

Parameters:

hreflang - The language of the link

Returns:

The builder

See Also:

Link.getHreflang()

type

Link.Builder type(@Nullable
                  MediaType mediaType)

Parameters:

mediaType - The type of the URI

Returns:

The builder

See Also:

Link.getType()

build

Link build()

Build the link.

Returns:

The Link