org.springframework.hateoas.mediatype.hal

Class Jackson2HalModule.EmbeddedMapper

java.lang.Object

org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper

Enclosing class:

Jackson2HalModule

public static class Jackson2HalModule.EmbeddedMapper
extends Object

Helper to easily map embedded resources and find out whether they were curied.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
EmbeddedMapper(LinkRelationProvider relProvider, CurieProvider curieProvider, boolean preferCollectionRels) Creates a new Jackson2HalModule.EmbeddedMapper for the given LinkRelationProvider, CurieProvider and flag whether to prefer collection relations.

Method Summary

Modifier and Type	Method and Description
boolean	hasCuriedEmbed(Iterable<?> source) Returns whether the given source elements will be namespaced.
Map<HalLinkRelation,Object>	map(Iterable<?> source) Maps the given source elements as embedded values.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedMapper

public EmbeddedMapper(LinkRelationProvider relProvider,
                      CurieProvider curieProvider,
                      boolean preferCollectionRels)

Creates a new Jackson2HalModule.EmbeddedMapper for the given LinkRelationProvider, CurieProvider and flag whether to prefer collection relations.

Parameters:

relProvider - must not be null.

curieProvider - must not be null.

preferCollectionRels -

Method Detail

map

public Map<HalLinkRelation,Object> map(Iterable<?> source)

Maps the given source elements as embedded values.

Parameters:

source - must not be null.

Returns:

hasCuriedEmbed

public boolean hasCuriedEmbed(Iterable<?> source)

Returns whether the given source elements will be namespaced.

Parameters:

source - must not be null.

Returns: