Package org.springframework.data.rest.core.mapping

Interface CollectionResourceMapping

All Superinterfaces:

ResourceMapping

All Known Subinterfaces:

ResourceMetadata

public interface CollectionResourceMapping
extends ResourceMapping

A custom resource mapping for collection resources.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method	Description
Optional<Class<?>>	getExcerptProjection()	Returns the projection type to be used when embedding item resources into collections and related resources.
ResourceDescription	getItemResourceDescription()	Returns the ResourceDescription for the item resource.
org.springframework.hateoas.LinkRelation	getItemResourceRel()	Returns the relation type pointing to the item resource within a collection.

Methods inherited from interface org.springframework.data.rest.core.mapping.ResourceMapping

getDescription, getPath, getRel, isExported, isPagingResource

Method Details

getItemResourceRel

org.springframework.hateoas.LinkRelation getItemResourceRel()

Returns the relation type pointing to the item resource within a collection.

Returns:

getItemResourceDescription

ResourceDescription getItemResourceDescription()

Returns the ResourceDescription for the item resource.

Returns:

getExcerptProjection

Optional<Class<?>> getExcerptProjection()

Returns the projection type to be used when embedding item resources into collections and related resources. If Optional.empty() is returned this will mean full rendering for collections and no rendering for related resources.

Returns: