Uses of Class
org.springframework.hateoas.CollectionModel

Packages that use CollectionModel

Package	Description
org.springframework.hateoas	Value objects to ease creating Links and link driven representations for REST webservices.
org.springframework.hateoas.mediatype.hal	HAL-specific extensions, SPIs and Jackson customizations.
org.springframework.hateoas.server	Server-side components for hypermedia handling.
org.springframework.hateoas.server.mvc	Spring MVC helper classes to build Links and assemble RepresentationModel types.
org.springframework.hateoas.server.reactive	Spring WebFlux components to build Links and assemble RepresentationModel types.

Uses of CollectionModel in org.springframework.hateoas

Subclasses of CollectionModel in org.springframework.hateoas

Modifier and Type	Class	Description
class	PagedModel<T>	DTO to implement binding response representations of pageable collections.
class	SlicedModel<T>	DTO to implement binding response representations of Slice collections.

Methods in org.springframework.hateoas that return CollectionModel

Modifier and Type	Method	Description
static <T> CollectionModel<T>	CollectionModel.empty()	Creates a new empty collection model.
static <T> CollectionModel<T>	CollectionModel.empty(Class<T> elementType, Class<?>... generics)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	CollectionModel.empty(Iterable<Link> links)	Creates a new empty collection model with the given links.
static <T> CollectionModel<T>	CollectionModel.empty(org.springframework.core.ParameterizedTypeReference<T> type)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	CollectionModel.empty(org.springframework.core.ResolvableType elementType)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	CollectionModel.empty(Link... links)	Creates a new empty collection model with the given links.
static <T> CollectionModel<T>	CollectionModel.of(Iterable<T> content)	Creates a CollectionModel instance with the given content.
static <T> CollectionModel<T>	CollectionModel.of(Iterable<T> content, Iterable<Link> links)	s Creates a CollectionModel instance with the given content and Links.
static <T> CollectionModel<T>	CollectionModel.of(Iterable<T> content, Link... links)	Creates a CollectionModel instance with the given content and Links (optional).
CollectionModel<T>	CollectionModel.withFallbackType(Class<? super T> type, Class<?>... generics)	Declares the given type as fallback element type in case the underlying collection is empty.
CollectionModel<T>	CollectionModel.withFallbackType(org.springframework.core.ParameterizedTypeReference<?> type)	Declares the given type as fallback element type in case the underlying collection is empty.
CollectionModel<T>	CollectionModel.withFallbackType(org.springframework.core.ResolvableType type)	Declares the given type as fallback element type in case the underlying collection is empty.
static <T extends EntityModel<S>, S> CollectionModel<T>	CollectionModel.wrap(Iterable<S> content)	Creates a new CollectionModel instance by wrapping the given domain class instances into a EntityModel.

Uses of CollectionModel in org.springframework.hateoas.mediatype.hal

Subclasses of CollectionModel in org.springframework.hateoas.mediatype.hal

Modifier and Type	Class	Description
class	CollectionModelMixin<T>	Custom mixin to to render collection content as _embedded.

Uses of CollectionModel in org.springframework.hateoas.server

Methods in org.springframework.hateoas.server that return CollectionModel

Modifier and Type	Method	Description
default CollectionModel<D>	RepresentationModelAssembler.toCollectionModel(Iterable<? extends T> entities)	Converts an Iterable or Ts into an Iterable of RepresentationModel and wraps them in a CollectionModel instance.
default CollectionModel<EntityModel<T>>	SimpleRepresentationModelAssembler.toCollectionModel(Iterable<? extends T> entities)	Converts all given entities into resources and wraps the collection as a resource as well.

Methods in org.springframework.hateoas.server with parameters of type CollectionModel

Modifier and Type	Method	Description
void	SimpleRepresentationModelAssembler.addLinks(CollectionModel<EntityModel<T>> resources)	Define links to add to the CollectionModel collection.

Uses of CollectionModel in org.springframework.hateoas.server.mvc

Methods in org.springframework.hateoas.server.mvc that return CollectionModel

Modifier and Type	Method	Description
CollectionModel<D>	RepresentationModelAssemblerSupport.toCollectionModel(Iterable<? extends T> entities)

Uses of CollectionModel in org.springframework.hateoas.server.reactive

Methods in org.springframework.hateoas.server.reactive that return CollectionModel

Modifier and Type	Method	Description
default CollectionModel<EntityModel<T>>	SimpleReactiveRepresentationModelAssembler.addLinks(CollectionModel<EntityModel<T>> resources, org.springframework.web.server.ServerWebExchange exchange)	Define links to add to the CollectionModel collection.

Methods in org.springframework.hateoas.server.reactive that return types with arguments of type CollectionModel

Modifier and Type	Method	Description
default reactor.core.publisher.Mono<CollectionModel<D>>	ReactiveRepresentationModelAssembler.toCollectionModel(reactor.core.publisher.Flux<? extends T> entities, org.springframework.web.server.ServerWebExchange exchange)	Converts an Iterable or Ts into an Iterable of RepresentationModel and wraps them in a CollectionModel instance.
default reactor.core.publisher.Mono<CollectionModel<EntityModel<T>>>	SimpleReactiveRepresentationModelAssembler.toCollectionModel(reactor.core.publisher.Flux<? extends T> entities, org.springframework.web.server.ServerWebExchange exchange)	Converts all given entities into resources and wraps the collection as a resource as well.

Methods in org.springframework.hateoas.server.reactive with parameters of type CollectionModel

Modifier and Type	Method	Description
default CollectionModel<EntityModel<T>>	SimpleReactiveRepresentationModelAssembler.addLinks(CollectionModel<EntityModel<T>> resources, org.springframework.web.server.ServerWebExchange exchange)	Define links to add to the CollectionModel collection.