org.springframework.hateoas.core
Interface EmbeddedWrapper

public interface EmbeddedWrapper

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

Author:

Oliver Gierke

Method Summary

String	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(String rel) Returns whether the wrapper hast the given rel.
boolean	isCollectionValue() Returns whether the wrapper is a collection value.

Method Detail

getRel

String getRel()

Returns the rel to be used when embedding. If this returns null, the rel will be calculated based on the type of the embedded value.

Returns:

hasRel

boolean hasRel(String rel)

Returns whether the wrapper hast 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

Class<?> getRelTargetType()

Returns the type to be used to calculate a type based rel.

Returns: