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

Class PersistentEntitiesResourceMappings

java.lang.Object

org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings

All Implemented Interfaces:

Iterable<ResourceMetadata>, Supplier<Stream<ResourceMetadata>>, ResourceMappings, Streamable<ResourceMetadata>

Direct Known Subclasses:

RepositoryResourceMappings

public class PersistentEntitiesResourceMappings
extends Object
implements ResourceMappings

ResourceMappings for PersistentEntities.

Author:

Oliver Gierke, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
PersistentEntitiesResourceMappings(PersistentEntities entities)	Creates a new PersistentEntitiesResourceMappings from the given PersistentEntities.

Method Summary

Modifier and Type	Method	Description
protected final void	addToCache(Class<?> type, ResourceMetadata metadata)	Adds the given ResourceMetadata to the cache.
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.
ResourceMapping	getMappingFor(PersistentProperty<?> property)
ResourceMetadata	getMetadataFor(Class<?> type)	Returns a ResourceMetadata for the given type if available.
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.
protected final boolean	hasMetadataFor(Class<?> type)	Returns whether we currently already have ResourceMetadata 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

Methods inherited from interface org.springframework.data.util.Streamable

and, and, and, and, filter, flatMap, get, isEmpty, map, stream, toList, toSet

Constructor Details

PersistentEntitiesResourceMappings

public PersistentEntitiesResourceMappings(PersistentEntities entities)

Creates a new PersistentEntitiesResourceMappings from the given PersistentEntities.

Parameters:

entities - must not be null.

Method Details

getMetadataFor

public ResourceMetadata getMetadataFor(Class<?> type)

Description copied from interface: ResourceMappings

Returns a ResourceMetadata for the given type if available.

Specified by:

getMetadataFor in interface ResourceMappings

Parameters:

type - must not be null.

Returns:

the ResourceMetadata if available or null otherwise.

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:

will never be null.

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>

addToCache

protected final void addToCache(Class<?> type,
 ResourceMetadata metadata)

Adds the given ResourceMetadata to the cache.

Parameters:

type - must not be null.

metadata - can be null.

hasMetadataFor

protected final boolean hasMetadataFor(Class<?> type)

Returns whether we currently already have ResourceMetadata for the given type.

Parameters:

type - must not be null.

Returns: