Package io.micronaut.http.hateoas

Class AbstractResource<Impl extends AbstractResource<Impl>>

java.lang.Object

io.micronaut.http.hateoas.AbstractResource<Impl>

Type Parameters:

Impl - An Abstract resource implementation

All Implemented Interfaces:

Resource

Direct Known Subclasses:

GenericResource, JsonError

@Produces("application/hal+json")
@Introspected
public abstract class AbstractResource<Impl extends AbstractResource<Impl>>
extends Object
implements Resource

An abstract implementation of Resource.

Since:

1.1

Author:

Graeme Rocher

Field Summary

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

EMBEDDED, LINKS

Constructor Summary

Constructors

Constructor	Description
AbstractResource()

Method Summary

Modifier and Type	Method	Description
Impl	embedded(CharSequence ref, Resource resource)	Add an embedded resource with the given reference.
Impl	embedded(CharSequence ref, Resource... resource)	Add an embedded resource with the given reference.
Impl	embedded(CharSequence ref, List<Resource> resourceList)	Add an embedded resource with the given reference.
OptionalMultiValues<Resource>	getEmbedded()
OptionalMultiValues<Link>	getLinks()
Impl	link(@Nullable CharSequence ref, @Nullable Link link)	Add a link with the given reference.
Impl	link(@Nullable CharSequence ref, @Nullable String link)	Add a link with the given reference.
final void	setEmbedded(Map<String,List<Resource>> embedded)	Allows de-serializing of embedded with Jackson.
final void	setLinks(Map<String,Object> links)	Allows de-serializing of links with Jackson.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractResource

public AbstractResource()

Method Details

link

public Impl link(@Nullable
 @Nullable CharSequence ref,
 @Nullable
 @Nullable Link link)

Add a link with the given reference.

Parameters:

ref - The reference

link - The link

Returns:

This JsonError

link

public Impl link(@Nullable
 @Nullable CharSequence ref,
 @Nullable
 @Nullable String link)

Add a link with the given reference.

Parameters:

ref - The reference

link - The link

Returns:

This JsonError

embedded

public Impl embedded(CharSequence ref,
 Resource resource)

Add an embedded resource with the given reference.

Parameters:

ref - The reference

resource - The resource

Returns:

This JsonError

embedded

public Impl embedded(CharSequence ref,
 Resource... resource)

Add an embedded resource with the given reference.

Parameters:

ref - The reference

resource - The resource

Returns:

This JsonError

embedded

public Impl embedded(CharSequence ref,
 List<Resource> resourceList)

Add an embedded resource with the given reference.

Parameters:

ref - The reference

resourceList - The resources

Returns:

This JsonError

getLinks

public OptionalMultiValues<Link> getLinks()

Specified by:

getLinks in interface Resource

Returns:

The links for this resource

getEmbedded

public OptionalMultiValues<Resource> getEmbedded()

Specified by:

getEmbedded in interface Resource

Returns:

The embedded resources

setLinks

@Internal
public final void setLinks(Map<String,Object> links)

Allows de-serializing of links with Jackson.

Parameters:

links - The links

setEmbedded

@Internal
public final void setEmbedded(Map<String,List<Resource>> embedded)

Allows de-serializing of embedded with Jackson.

Parameters:

embedded - The links