org.springframework.data.rest.webmvc

Class PersistentEntityResource.Builder

java.lang.Object

org.springframework.data.rest.webmvc.PersistentEntityResource.Builder

Enclosing class:

PersistentEntityResource

public static class PersistentEntityResource.Builder
extends Object

Builder to create PersistentEntityResource instances.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
PersistentEntityResource	build() Finally creates the PersistentEntityResource instance.
PersistentEntityResource	buildNested()
PersistentEntityResource	forCreation() Finally creates the PersistentEntityResource instance to symbolize the contained entity is about to be created.
PersistentEntityResource.Builder	withEmbedded(Iterable<org.springframework.hateoas.server.core.EmbeddedWrapper> resources) Configures the builder to embed the given EmbeddedWrapper instances.
PersistentEntityResource.Builder	withLink(org.springframework.hateoas.Link link) Adds the given Link to the PersistentEntityResource.
PersistentEntityResource.Builder	withLinks(List<org.springframework.hateoas.Link> links)

Methods inherited from class java.lang.Object

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

Method Detail

withEmbedded

public PersistentEntityResource.Builder withEmbedded(Iterable<org.springframework.hateoas.server.core.EmbeddedWrapper> resources)

Configures the builder to embed the given EmbeddedWrapper instances. Creates a Resources instance to make sure the EmbeddedWrapper handling gets applied to the serialization output ignoring the links.

Parameters:

resources - can be null.

Returns:

the builder

withLink

public PersistentEntityResource.Builder withLink(org.springframework.hateoas.Link link)

Adds the given Link to the PersistentEntityResource.

Parameters:

link - must not be null.

Returns:

the builder

withLinks

public PersistentEntityResource.Builder withLinks(List<org.springframework.hateoas.Link> links)

build

public PersistentEntityResource build()

Finally creates the PersistentEntityResource instance.

Returns:

forCreation

public PersistentEntityResource forCreation()

Finally creates the PersistentEntityResource instance to symbolize the contained entity is about to be created.

Returns:

buildNested

public PersistentEntityResource buildNested()