org.springframework.data.rest.core.mapping

Interface ResourceMappings

All Superinterfaces:

Iterable<ResourceMetadata>

All Known Implementing Classes:

PersistentEntitiesResourceMappings, RepositoryResourceMappings

public interface ResourceMappings
extends Iterable<ResourceMetadata>

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
boolean	exportsMappingFor(Class<?> type) Returns whether we have a ResourceMapping for the given type and it is exported.
boolean	exportsTopLevelResourceFor(String path) Returns whether we export a top-level resource for the given path.
ResourceMetadata	getMetadataFor(Class<?> type) Returns a ResourceMetadata for the given type if available.
SearchResourceMappings	getSearchResourceMappings(Class<?> type) Returns the ResourceMappings for the search resources of the given type.
boolean	hasMappingFor(Class<?> type) Returns whether we have a ResourceMapping for the given type.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getMetadataFor

ResourceMetadata getMetadataFor(Class<?> type)

Returns a ResourceMetadata for the given type if available.

Parameters:

type - must not be null.

Returns:

the ResourceMetadata if available or null otherwise.

getSearchResourceMappings

SearchResourceMappings getSearchResourceMappings(Class<?> type)

Returns the ResourceMappings for the search resources of the given type.

Parameters:

type - must not be null.

Returns:

will never be null.

exportsMappingFor

boolean exportsMappingFor(Class<?> type)

Returns whether we have a ResourceMapping for the given type and it is exported.

Parameters:

type -

Returns:

exportsTopLevelResourceFor

boolean exportsTopLevelResourceFor(String path)

Returns whether we export a top-level resource for the given path.

Parameters:

path - must not be null or empty.

Returns:

hasMappingFor

boolean hasMappingFor(Class<?> type)

Returns whether we have a ResourceMapping for the given type.

Parameters:

type - must not be null.

Returns: