Package 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	Description
Link	build()	Build the link.
Link.Builder	deprecation(@Nullable String deprecationURI)
Link.Builder	deprecation(@Nullable URI deprecation)
Link.Builder	hreflang(@Nullable String hreflang)
Link.Builder	name(@Nullable String name)
Link.Builder	profile(@Nullable String profileURI)
Link.Builder	profile(@Nullable URI profile)
Link.Builder	templated(boolean templated)
Link.Builder	title(@Nullable String title)
Link.Builder	type(@Nullable MediaType mediaType)

Method Details

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
 @Nullable URI profile)

Parameters:

profile - The profile URI

Returns:

The builder

See Also:

• Link.getProfile()

profile

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

Parameters:

profileURI - The profile URI

Returns:

The builder

See Also:

• Link.getProfile()

deprecation

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

Parameters:

deprecation - The deprecation URI

Returns:

The builder

See Also:

• Link.getDeprecation()

deprecation

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

Parameters:

deprecationURI - The deprecation URI

Returns:

The builder

See Also:

• Link.getDeprecation()

title

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

Parameters:

title - The title of the link

Returns:

The builder

See Also:

• Link.getTitle()

name

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

Parameters:

name - The name of the link

Returns:

The builder

See Also:

• Link.getName()

hreflang

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

Parameters:

hreflang - The language of the link

Returns:

The builder

See Also:

• Link.getHreflang()

type

Link.Builder type(@Nullable
 @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