org.springframework.hateoas

Class PagedModel<T>

java.lang.Object

org.springframework.hateoas.RepresentationModel<CollectionModel<T>>

org.springframework.hateoas.CollectionModel<T>

org.springframework.hateoas.PagedModel<T>

All Implemented Interfaces:

Iterable<T>, ResolvableTypeProvider

public class PagedModel<T>
extends CollectionModel<T>

DTO to implement binding response representations of pageable collections.

Author:

Oliver Gierke, Greg Turnquist

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PagedModel.PageMetadata Value object for pagination metadata.

Field Summary

Fields

Modifier and Type	Field and Description
static PagedModel<?>	NO_PAGE

Constructor Summary

Constructors

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)

Method Summary

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) Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
static <T> PagedModel<T>	of(Collection<T> content, PagedModel.PageMetadata metadata, Iterable<Link> links) Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.
static <T> PagedModel<T>	of(Collection<T> content, PagedModel.PageMetadata metadata, Link... links) Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
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> PagedModel<T>	wrap(Iterable<S> content, PagedModel.PageMetadata metadata) Factory method to easily create a PagedModel instance from a set of entities and pagination metadata.

Methods inherited from class org.springframework.hateoas.CollectionModel

empty, getContent, getResolvableType, iterator, of, of, of, wrap

Methods inherited from class org.springframework.hateoas.RepresentationModel

add, add, add, addAllIf, addIf, getLink, getLink, getLinks, getLinks, getLinks, getRequiredLink, getRequiredLink, hasLink, hasLink, hasLinks, mapLink, mapLinkIf, removeLinks

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

NO_PAGE

public static PagedModel<?> NO_PAGE

Constructor Detail

PagedModel

protected PagedModel()

Default constructor to allow instantiation by reflection.

PagedModel

protected PagedModel(Collection<T> content,
                     @Nullable
                     PagedModel.PageMetadata metadata)

PagedModel

protected PagedModel(Collection<T> content,
                     @Nullable
                     PagedModel.PageMetadata metadata,
                     Iterable<Link> links)

PagedModel

protected PagedModel(Collection<T> content,
                     @Nullable
                     PagedModel.PageMetadata metadata,
                     Iterable<Link> links,
                     @Nullable
                     ResolvableType fallbackType)

Method Detail

empty

public static <T> PagedModel<T> empty()

Creates an empty PagedModel.

Type Parameters:

T -

Returns:

will never be null.

Since:

1.1

empty

public static <T> PagedModel<T> empty(Class<T> fallbackElementType,
                                      Class<?> generics)

Creates an empty PagedModel with the given fallback type.

Type Parameters:

T -

Parameters:

fallbackElementType - must not be null.

generics - must not be null.

Returns:

will never be null.

Since:

1.4

See Also:

withFallbackType(Class, Class...)

empty

public static <T> PagedModel<T> empty(ParameterizedTypeReference<T> fallbackElementType)

Creates an empty PagedModel with the given fallback type.

Type Parameters:

T -

Parameters:

fallbackElementType - must not be null.

Returns:

will never be null.

Since:

1.4

See Also:

withFallbackType(ParameterizedTypeReference)

empty

public static <T> PagedModel<T> empty(ResolvableType fallbackElementType)

Creates an empty PagedModel with the given fallback type.

Type Parameters:

T -

Parameters:

fallbackElementType - must not be null.

Returns:

will never be null.

Since:

1.4

See Also:

withFallbackType(ResolvableType)

empty

public static <T> PagedModel<T> empty(Link... links)

Creates an empty PagedModel with the given links.

Type Parameters:

T -

Parameters:

links - must not be null.

Returns:

Since:

1.1

empty

public static <T> PagedModel<T> empty(Iterable<Link> links)

Creates an empty PagedModel with the given links.

Type Parameters:

T -

Parameters:

links - must not be null.

Returns:

Since:

1.1

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata)

Creates an empty PagedModel with the given PagedModel.PageMetadata.

Type Parameters:

T -

Parameters:

metadata - can be null.

Returns:

Since:

1.1

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata,
                                      Class<?> fallbackType,
                                      Class<?>... generics)

Creates an empty PagedModel with the given PagedModel.PageMetadata and fallback type.

Type Parameters:

T -

Parameters:

metadata - can be null.

fallbackType - must not be null.

generics - must not be null.

Returns:

will never be null.

Since:

1.4

See Also:

withFallbackType(Class, Class...)

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata,
                                      ParameterizedTypeReference<T> fallbackType)

Creates an empty PagedModel with the given PagedModel.PageMetadata and fallback type.

Type Parameters:

T -

Parameters:

metadata - can be null.

Returns:

Since:

1.4

See Also:

withFallbackType(ParameterizedTypeReference)

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata,
                                      ResolvableType fallbackType)

Creates an empty PagedModel with the given PagedModel.PageMetadata and fallback type.

Type Parameters:

T -

Parameters:

metadata - can be null.

fallbackType - must not be null.

Returns:

Since:

1.4

See Also:

withFallbackType(ResolvableType)

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata,
                                      Link... links)

Creates an empty PagedModel with the given PagedModel.PageMetadata and links.

Type Parameters:

T -

Parameters:

metadata - can be null.

links - must not be null.

Returns:

Since:

1.1

empty

public static <T> PagedModel<T> empty(@Nullable
                                      PagedModel.PageMetadata metadata,
                                      Iterable<Link> links)

Creates an empty PagedModel with the given PagedModel.PageMetadata and links.

Type Parameters:

T -

Parameters:

metadata - can be null.

links - must not be null.

Returns:

Since:

1.1

of

public static <T> PagedModel<T> of(Collection<T> content,
                                   @Nullable
                                   PagedModel.PageMetadata metadata)

Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).

Parameters:

content - must not be null.

metadata - can be null.

links -

of

public static <T> PagedModel<T> of(Collection<T> content,
                                   @Nullable
                                   PagedModel.PageMetadata metadata,
                                   Link... links)

Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).

Parameters:

content - must not be null.

metadata - can be null.

links -

of

public static <T> PagedModel<T> of(Collection<T> content,
                                   @Nullable
                                   PagedModel.PageMetadata metadata,
                                   Iterable<Link> links)

Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.

Parameters:

content - must not be null.

metadata - can be null.

links -

getMetadata

@Nullable
public PagedModel.PageMetadata getMetadata()

Returns the pagination metadata.

Returns:

the metadata

wrap

public static <T extends EntityModel<S>,S> PagedModel<T> wrap(Iterable<S> content,
                                                              PagedModel.PageMetadata metadata)

Factory method to easily create a PagedModel instance from a set of entities and pagination metadata.

Parameters:

content - must not be null.

metadata -

Returns:

getNextLink

public Optional<Link> getNextLink()

Returns the Link pointing to the next page (if set).

Returns:

getPreviousLink

public Optional<Link> getPreviousLink()

Returns the Link pointing to the previous page (if set).

Returns:

withFallbackType

public PagedModel<T> withFallbackType(Class<? super T> type,
                                      Class<?>... generics)

Description copied from class: CollectionModel

Declares the given type as fallback element type in case the underlying collection is empty. This allows client components to still apply type matches at runtime.

Overrides:

withFallbackType in class CollectionModel<T>

Parameters:

type - must not be null.

Returns:

will never be null.

withFallbackType

public PagedModel<T> withFallbackType(ParameterizedTypeReference<?> type)

Description copied from class: CollectionModel

Declares the given type as fallback element type in case the underlying collection is empty. This allows client components to still apply type matches at runtime.

Overrides:

withFallbackType in class CollectionModel<T>

Parameters:

type - must not be null.

Returns:

will never be null.

withFallbackType

public PagedModel<T> withFallbackType(ResolvableType type)

Description copied from class: CollectionModel

Declares the given type as fallback element type in case the underlying collection is empty. This allows client components to still apply type matches at runtime.

Overrides:

withFallbackType in class CollectionModel<T>

Parameters:

type - must not be null.

Returns:

will never be null.

toString

public String toString()

Overrides:

toString in class CollectionModel<T>

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class CollectionModel<T>

hashCode

public int hashCode()

Overrides:

hashCode in class CollectionModel<T>