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

Interface ResourceMappings

All Superinterfaces:

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

All Known Implementing Classes:

PersistentEntitiesResourceMappings, RepositoryResourceMappings

public interface ResourceMappings
extends Streamable<ResourceMetadata>

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method	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.
@Nullable ResourceMetadata	getMetadataFor(Class<?> type)	Returns a ResourceMetadata for the given type if available.
default ResourceMetadata	getRequiredMetadataFor(Class<?> type)	Returns the required ResourceMetadata for the given type or throws IllegalStateException.
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

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

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

Method Details

getMetadataFor

@Nullable 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.

getRequiredMetadataFor

default ResourceMetadata getRequiredMetadataFor(Class<?> type)

Returns the required ResourceMetadata for the given type or throws IllegalStateException.

Parameters:

type - must not be null.

Returns:

the ResourceMetadata if available or null otherwise.

Throws:

IllegalArgumentException - if no ResourceMetadata is available for the given type.

Since:

5.0

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: