Package org.springframework.hateoas.server.core

Class EmbeddedWrappers

java.lang.Object

org.springframework.hateoas.server.core.EmbeddedWrappers

public class EmbeddedWrappers
extends Object

Interface to mark objects that are aware of the rel they'd like to be exposed under.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor	Description
EmbeddedWrappers(boolean preferCollections)	Creates a new EmbeddedWrappers.

Method Summary

Modifier and Type	Method	Description
EmbeddedWrapper	emptyCollectionOf(Class<?> type)	Creates an EmbeddedWrapper for an empty Collection with the given element type.
EmbeddedWrapper	wrap(Object source)	Creates a new EmbeddedWrapper that
EmbeddedWrapper	wrap(Object source, LinkRelation rel)	Creates a new EmbeddedWrapper with the given rel.

Methods inherited from class java.lang.Object

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

Constructor Details

EmbeddedWrappers

public EmbeddedWrappers(boolean preferCollections)

Creates a new EmbeddedWrappers.

Parameters:

preferCollections - whether wrappers for single elements should rather treat the value as collection.

Method Details

wrap

public EmbeddedWrapper wrap(Object source)

Creates a new EmbeddedWrapper that

Parameters:

source - must not be null.

Returns:

will never be null.

emptyCollectionOf

public EmbeddedWrapper emptyCollectionOf(Class<?> type)

Creates an EmbeddedWrapper for an empty Collection with the given element type.

Parameters:

type - must not be null.

Returns:

wrap

public EmbeddedWrapper wrap(Object source,
 LinkRelation rel)

Creates a new EmbeddedWrapper with the given rel.

Parameters:

source - must not be null.

rel - must not be null or empty.

Returns:

will never be null.