public class PagedModel<T> extends CollectionModel<T>
Modifier and Type | Class and Description |
---|---|
static class |
PagedModel.PageMetadata
Value object for pagination metadata.
|
Modifier and Type | Field and Description |
---|---|
static PagedModel<?> |
NO_PAGE |
Modifier | Constructor and Description |
---|---|
protected |
PagedModel()
Default constructor to allow instantiation by reflection.
|
protected |
PagedModel(Collection<T> content,
PagedModel.PageMetadata metadata) |
protected |
PagedModel(Collection<T> content,
PagedModel.PageMetadata metadata,
Iterable<Link> links) |
protected |
PagedModel(Collection<T> content,
PagedModel.PageMetadata metadata,
Iterable<Link> links,
ResolvableType fallbackType) |
Modifier and Type | Method and Description |
---|---|
static <T> PagedModel<T> |
empty()
Creates an empty
PagedModel . |
static <T> PagedModel<T> |
empty(Class<T> fallbackElementType,
Class<?> generics)
Creates an empty
PagedModel with the given fallback type. |
static <T> PagedModel<T> |
empty(Iterable<Link> links)
Creates an empty
PagedModel with the given links. |
static <T> PagedModel<T> |
empty(Link... links)
Creates an empty
PagedModel with the given links. |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata)
Creates an empty
PagedModel with the given PagedModel.PageMetadata . |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata,
Class<?> fallbackType,
Class<?>... generics)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and fallback type. |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata,
Iterable<Link> links)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and links. |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata,
Link... links)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and links. |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata,
ParameterizedTypeReference<T> fallbackType)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and fallback type. |
static <T> PagedModel<T> |
empty(PagedModel.PageMetadata metadata,
ResolvableType fallbackType)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and fallback type. |
static <T> PagedModel<T> |
empty(ParameterizedTypeReference<T> fallbackElementType)
Creates an empty
PagedModel with the given fallback type. |
static <T> PagedModel<T> |
empty(ResolvableType fallbackElementType)
Creates an empty
PagedModel with the given fallback type. |
boolean |
equals(Object obj) |
PagedModel.PageMetadata |
getMetadata()
Returns the pagination metadata.
|
Optional<Link> |
getNextLink()
Returns the Link pointing to the next page (if set).
|
Optional<Link> |
getPreviousLink()
Returns the Link pointing to the previous page (if set).
|
int |
hashCode() |
static <T> PagedModel<T> |
of(Collection<T> content,
PagedModel.PageMetadata metadata)
|
static <T> PagedModel<T> |
of(Collection<T> content,
PagedModel.PageMetadata metadata,
Iterable<Link> links)
|
static <T> PagedModel<T> |
of(Collection<T> content,
PagedModel.PageMetadata metadata,
Link... links)
|
String |
toString() |
PagedModel<T> |
withFallbackType(Class<? super T> type,
Class<?>... generics)
Declares the given type as fallback element type in case the underlying collection is empty.
|
PagedModel<T> |
withFallbackType(ParameterizedTypeReference<?> type)
Declares the given type as fallback element type in case the underlying collection is empty.
|
PagedModel<T> |
withFallbackType(ResolvableType type)
Declares the given type as fallback element type in case the underlying collection is empty.
|
static <T extends EntityModel<S>,S> |
wrap(Iterable<S> content,
PagedModel.PageMetadata metadata)
Factory method to easily create a
PagedModel instance from a set of entities and pagination metadata. |
empty, getContent, getResolvableType, iterator, of, of, of, wrap
add, add, add, addAllIf, addIf, getLink, getLink, getLinks, getLinks, getLinks, getRequiredLink, getRequiredLink, hasLink, hasLink, hasLinks, mapLink, mapLinkIf, removeLinks
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
forEach, spliterator
public static PagedModel<?> NO_PAGE
protected PagedModel()
protected PagedModel(Collection<T> content, @Nullable PagedModel.PageMetadata metadata)
protected PagedModel(Collection<T> content, @Nullable PagedModel.PageMetadata metadata, Iterable<Link> links)
protected PagedModel(Collection<T> content, @Nullable PagedModel.PageMetadata metadata, Iterable<Link> links, @Nullable ResolvableType fallbackType)
public static <T> PagedModel<T> empty()
PagedModel
.T
- public static <T> PagedModel<T> empty(Class<T> fallbackElementType, Class<?> generics)
PagedModel
with the given fallback type.T
- fallbackElementType
- must not be null.generics
- must not be null.withFallbackType(Class, Class...)
public static <T> PagedModel<T> empty(ParameterizedTypeReference<T> fallbackElementType)
PagedModel
with the given fallback type.T
- fallbackElementType
- must not be null.withFallbackType(ParameterizedTypeReference)
public static <T> PagedModel<T> empty(ResolvableType fallbackElementType)
PagedModel
with the given fallback type.T
- fallbackElementType
- must not be null.withFallbackType(ResolvableType)
public static <T> PagedModel<T> empty(Link... links)
PagedModel
with the given links.T
- links
- must not be null.public static <T> PagedModel<T> empty(Iterable<Link> links)
PagedModel
with the given links.T
- links
- must not be null.public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata)
PagedModel
with the given PagedModel.PageMetadata
.T
- metadata
- can be null.public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, Class<?> fallbackType, Class<?>... generics)
PagedModel
with the given PagedModel.PageMetadata
and fallback type.T
- metadata
- can be null.fallbackType
- must not be null.generics
- must not be null.withFallbackType(Class, Class...)
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, ParameterizedTypeReference<T> fallbackType)
PagedModel
with the given PagedModel.PageMetadata
and fallback type.T
- metadata
- can be null.withFallbackType(ParameterizedTypeReference)
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, ResolvableType fallbackType)
PagedModel
with the given PagedModel.PageMetadata
and fallback type.T
- metadata
- can be null.fallbackType
- must not be null.withFallbackType(ResolvableType)
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, Link... links)
PagedModel
with the given PagedModel.PageMetadata
and links.T
- metadata
- can be null.links
- must not be null.public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, Iterable<Link> links)
PagedModel
with the given PagedModel.PageMetadata
and links.T
- metadata
- can be null.links
- must not be null.public static <T> PagedModel<T> of(Collection<T> content, @Nullable PagedModel.PageMetadata metadata)
content
- must not be null.metadata
- can be null.links
- public static <T> PagedModel<T> of(Collection<T> content, @Nullable PagedModel.PageMetadata metadata, Link... links)
content
- must not be null.metadata
- can be null.links
- public static <T> PagedModel<T> of(Collection<T> content, @Nullable PagedModel.PageMetadata metadata, Iterable<Link> links)
content
- must not be null.metadata
- can be null.links
- @Nullable public PagedModel.PageMetadata getMetadata()
public static <T extends EntityModel<S>,S> PagedModel<T> wrap(Iterable<S> content, PagedModel.PageMetadata metadata)
PagedModel
instance from a set of entities and pagination metadata.content
- must not be null.metadata
- public Optional<Link> getNextLink()
public Optional<Link> getPreviousLink()
public PagedModel<T> withFallbackType(Class<? super T> type, Class<?>... generics)
CollectionModel
withFallbackType
in class CollectionModel<T>
type
- must not be null.public PagedModel<T> withFallbackType(ParameterizedTypeReference<?> type)
CollectionModel
withFallbackType
in class CollectionModel<T>
type
- must not be null.public PagedModel<T> withFallbackType(ResolvableType type)
CollectionModel
withFallbackType
in class CollectionModel<T>
type
- must not be null.public String toString()
toString
in class CollectionModel<T>
public boolean equals(@Nullable Object obj)
equals
in class CollectionModel<T>
public int hashCode()
hashCode
in class CollectionModel<T>
Copyright © 2011–2021 Pivotal, Inc.. All rights reserved.