org.springframework.data.rest.webmvc

Class PersistentEntityResource

java.lang.Object

org.springframework.hateoas.ResourceSupport

org.springframework.hateoas.Resource<Object>

org.springframework.data.rest.webmvc.PersistentEntityResource

All Implemented Interfaces:

org.springframework.hateoas.Identifiable<org.springframework.hateoas.Link>

public class PersistentEntityResource
extends org.springframework.hateoas.Resource<Object>

A Spring HATEOAS Resource subclass that holds a reference to the entity's PersistentEntity metadata.

Author:

Jon Brisbin, Oliver Gierke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentEntityResource.Builder Builder to create PersistentEntityResource instances.

Method Summary

Modifier and Type	Method and Description
static PersistentEntityResource.Builder	build(Object content, PersistentEntity<?,?> entity) Creates a new PersistentEntityResource.Builder to create PersistentEntityResources eventually.
Iterable<org.springframework.hateoas.core.EmbeddedWrapper>	getEmbeddeds() Returns the resources that are supposed to be rendered in the _embedded clause.
PersistentEntity<?,? extends PersistentProperty<?>>	getPersistentEntity() Returns the PersistentEntity for the underlying instance.
PersistentPropertyAccessor	getPropertyAccessor() Returns the PersistentPropertyAccessor for the underlying content bean.
boolean	isNew() Returns whether the content of the resource is a new entity about to be created.

Methods inherited from class org.springframework.hateoas.Resource

equals, getContent, hashCode, toString

Methods inherited from class org.springframework.hateoas.ResourceSupport

add, add, add, getId, getLink, getLinks, hasLink, hasLinks, removeLinks

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPersistentEntity

public PersistentEntity<?,? extends PersistentProperty<?>> getPersistentEntity()

Returns the PersistentEntity for the underlying instance.

Returns:

getPropertyAccessor

public PersistentPropertyAccessor getPropertyAccessor()

Returns the PersistentPropertyAccessor for the underlying content bean.

Returns:

getEmbeddeds

public Iterable<org.springframework.hateoas.core.EmbeddedWrapper> getEmbeddeds()

Returns the resources that are supposed to be rendered in the _embedded clause.

Returns:

the embeddeds

isNew

public boolean isNew()

Returns whether the content of the resource is a new entity about to be created. Used to distinguish between creation and updates for incoming requests.

Returns:

build

public static PersistentEntityResource.Builder build(Object content,
                                                     PersistentEntity<?,?> entity)

Creates a new PersistentEntityResource.Builder to create PersistentEntityResources eventually.

Parameters:

content - must not be null.

entity - must not be null.

Returns: