org.springframework.data.rest.core.mapping

Class RepositoryResourceMappings

java.lang.Object

org.springframework.data.rest.core.mapping.RepositoryResourceMappings

All Implemented Interfaces:

Iterable<ResourceMetadata>, ResourceMappings

public class RepositoryResourceMappings
extends Object
implements ResourceMappings

Central abstraction obtain ResourceMetadata and ResourceMapping instances for domain types and repositories.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RepositoryResourceMappings(RepositoryRestConfiguration config, Repositories repositories) Creates a new RepositoryResourceMappings using the given RepositoryRestConfiguration and Repositories .
RepositoryResourceMappings(RepositoryRestConfiguration config, Repositories repositories, org.springframework.hateoas.RelProvider relProvider) Creates a new RepositoryResourceMappings from the given RepositoryRestConfiguration, Repositories and RelProvider.

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	getMappingFor(Class<?> type) Returns a ResourceMetadata for the given type if available.
ResourceMapping	getMappingFor(PersistentProperty<?> property)
SearchResourceMappings	getSearchResourceMappings(Class<?> domainType) 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.
boolean	isMapped(PersistentProperty<?> property)
Iterator<ResourceMetadata>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RepositoryResourceMappings

public RepositoryResourceMappings(RepositoryRestConfiguration config,
                                  Repositories repositories)

Creates a new RepositoryResourceMappings using the given RepositoryRestConfiguration and Repositories .

Parameters:

config -

repositories -

RepositoryResourceMappings

public RepositoryResourceMappings(RepositoryRestConfiguration config,
                                  Repositories repositories,
                                  org.springframework.hateoas.RelProvider relProvider)

Creates a new RepositoryResourceMappings from the given RepositoryRestConfiguration, Repositories and RelProvider.

Parameters:

config - must not be null.

repositories - must not be null.

relProvider - must not be null.

Method Detail

getMappingFor

public ResourceMetadata getMappingFor(Class<?> type)

Description copied from interface: ResourceMappings

Returns a ResourceMetadata for the given type if available.

Specified by:

getMappingFor in interface ResourceMappings

Parameters:

type - must not be null.

Returns:

getSearchResourceMappings

public SearchResourceMappings getSearchResourceMappings(Class<?> domainType)

Description copied from interface: ResourceMappings

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

Specified by:

getSearchResourceMappings in interface ResourceMappings

Parameters:

domainType - must not be null.

Returns:

exportsMappingFor

public boolean exportsMappingFor(Class<?> type)

Description copied from interface: ResourceMappings

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

Specified by:

exportsMappingFor in interface ResourceMappings

Returns:

exportsTopLevelResourceFor

public boolean exportsTopLevelResourceFor(String path)

Description copied from interface: ResourceMappings

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

Specified by:

exportsTopLevelResourceFor in interface ResourceMappings

Parameters:

path - must not be null or empty.

Returns:

hasMappingFor

public boolean hasMappingFor(Class<?> type)

Description copied from interface: ResourceMappings

Returns whether we have a ResourceMapping for the given type.

Specified by:

hasMappingFor in interface ResourceMappings

Parameters:

type - must not be null.

Returns:

getMappingFor

public ResourceMapping getMappingFor(PersistentProperty<?> property)

isMapped

public boolean isMapped(PersistentProperty<?> property)

iterator

public Iterator<ResourceMetadata> iterator()

Specified by:

iterator in interface Iterable<ResourceMetadata>