org.springframework.data.rest.core.mapping

Interface ResourceMapping

All Known Subinterfaces:

CollectionResourceMapping, MethodResourceMapping, PropertyAwareResourceMapping, ResourceMetadata

All Known Implementing Classes:

SearchResourceMappings

public interface ResourceMapping

Mapping information for components to be exported as REST resources.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
ResourceDescription	getDescription() Returns the resource's description.
Path	getPath() Returns the path the resource is exposed under.
String	getRel() Returns the relation for the resource exported.
boolean	isExported() Returns whether the component shall be exported at all.
boolean	isPagingResource() Returns whether the resource is paging one.

Method Detail

isExported

boolean isExported()

Returns whether the component shall be exported at all.

Returns:

will never be null.

getRel

String getRel()

Returns the relation for the resource exported.

Returns:

will never be null.

getPath

Path getPath()

Returns the path the resource is exposed under.

Returns:

will never be null.

isPagingResource

boolean isPagingResource()

Returns whether the resource is paging one.

Returns:

getDescription

ResourceDescription getDescription()

Returns the resource's description.

Returns: