org.springframework.hateoas.server.core

Interface EmbeddedWrapper

public interface EmbeddedWrapper

A wrapper to handle values to be embedded into a EntityModel.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
Optional<LinkRelation>	getRel() Returns the rel to be used when embedding.
Class<?>	getRelTargetType() Returns the type to be used to calculate a type based rel.
Object	getValue() Returns the actual value to embed.
boolean	hasRel(LinkRelation rel) Returns whether the wrapper has the given rel.
boolean	isCollectionValue() Returns whether the wrapper is a collection value.

Method Detail

getRel

Optional<LinkRelation> getRel()

Returns the rel to be used when embedding. If this returns null, the rel will be calculated based on the type returned by getRelTargetType(). A wrapper returning null for both getRel() and getRelTargetType() is considered invalid.

Returns:

See Also:

getRelTargetType()

hasRel

boolean hasRel(LinkRelation rel)

Returns whether the wrapper has the given rel.

Parameters:

rel - can be null.

Returns:

isCollectionValue

boolean isCollectionValue()

Returns whether the wrapper is a collection value.

Returns:

getValue

Object getValue()

Returns the actual value to embed.

Returns:

getRelTargetType

@Nullable
Class<?> getRelTargetType()

Returns the type to be used to calculate a type based rel. Can return null in case an explicit rel is returned in getRel(). A wrapper returning null for both getRel() and getRelTargetType() is considered invalid.

Returns: