Package org.springframework.hateoas

Class SlicedModel<T>

java.lang.Object

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

org.springframework.hateoas.CollectionModel<T>

org.springframework.hateoas.SlicedModel<T>

All Implemented Interfaces:

Iterable<T>, ResolvableTypeProvider

public class SlicedModel<T>
extends CollectionModel<T>

DTO to implement binding response representations of Slice collections.

Since:

2.1

Author:

Michael Schout, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SlicedModel.SliceMetadata	Value object for slice metadata.

Field Summary

Fields

Modifier and Type	Field	Description
static SlicedModel<?>	NO_SLICE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SlicedModel()	Default constructor to allow instantiation by reflection.
protected	SlicedModel(Collection<T> content, SlicedModel.SliceMetadata metadata)
protected	SlicedModel(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links)
protected	SlicedModel(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links, ResolvableType fallbackType)

Method Summary

Modifier and Type	Method	Description
static <T> SlicedModel<T>	empty()	Creates an empty SlicedModel.
static <T> SlicedModel<T>	empty(Class<T> fallbackElementType, Class<?> generics)	Creates an empty SlicedModel with the given fallback type.
static <T> SlicedModel<T>	empty(Iterable<Link> links)	Creates an empty SlicedModel with the given links.
static <T> SlicedModel<T>	empty(ParameterizedTypeReference<T> fallbackElementType)	Creates an empty SlicedModel with the given fallback type.
static <T> SlicedModel<T>	empty(ResolvableType fallbackElementType)	Creates an empty SlicedModel with the given fallback type.
static <T> SlicedModel<T>	empty(Link... links)	Creates an empty SlicedModel with the given links.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata, Class<?> fallbackType, Class<?>... generics)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata, Iterable<Link> links)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata, ParameterizedTypeReference<T> fallbackType)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata, ResolvableType fallbackType)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.
static <T> SlicedModel<T>	empty(SlicedModel.SliceMetadata metadata, Link... links)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.
boolean	equals(Object obj)
SlicedModel.SliceMetadata	getMetadata()	Returns the pagination metadata.
Optional<Link>	getNextLink()	Returns the Link pointing to the next slice (if set).
Optional<Link>	getPreviousLink()	Returns the Link pointing to the previous slice (if set).
int	hashCode()
static <T> SlicedModel<T>	of(Collection<T> content, SlicedModel.SliceMetadata metadata)	Creates a new SlicedModel from the given content, SlicedModel.SliceMetadata and Links (optional).
static <T> SlicedModel<T>	of(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links)	Creates a new SlicedModel from the given content SlicedModel.SliceMetadata and Links.
static <T> SlicedModel<T>	of(Collection<T> content, SlicedModel.SliceMetadata metadata, Link... links)	Creates a new SlicedModel from the given content, SlicedModel.SliceMetadata and Links (optional).
String	toString()
SlicedModel<T>	withFallbackType(Class<? super T> type, Class<?>... generics)	Declares the given type as fallback element type in case the underlying collection is empty.
SlicedModel<T>	withFallbackType(ParameterizedTypeReference<?> type)	Declares the given type as fallback element type in case the underlying collection is empty.
SlicedModel<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> SlicedModel<T>	wrap(Iterable<S> content, SlicedModel.SliceMetadata metadata)	Factory method to easily create a SlicedModel 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, of, of, 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 Details

NO_SLICE

public static SlicedModel<?> NO_SLICE

Constructor Details

SlicedModel

protected SlicedModel()

Default constructor to allow instantiation by reflection.

SlicedModel

protected SlicedModel(Collection<T> content,
 @Nullable
 SlicedModel.SliceMetadata metadata)

SlicedModel

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

SlicedModel

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

Method Details

empty

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

Creates an empty SlicedModel.

Type Parameters:

T - the payload type.

Returns:

will never be null.

empty

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

Creates an empty SlicedModel with the given fallback type.

Type Parameters:

T - the payload type.

Parameters:

fallbackElementType - must not be null.

generics - must not be null.

Returns:

will never be null.

See Also:

• withFallbackType(Class, Class...)

empty

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

Creates an empty SlicedModel with the given fallback type.

Type Parameters:

T - the payload type.

Parameters:

fallbackElementType - must not be null.

Returns:

will never be null.

See Also:

• withFallbackType(ParameterizedTypeReference)

empty

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

Creates an empty SlicedModel with the given fallback type.

Type Parameters:

T - the payload type.

Parameters:

fallbackElementType - must not be null.

Returns:

will never be null.

See Also:

• withFallbackType(ResolvableType)

empty

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

Creates an empty SlicedModel with the given links.

Type Parameters:

T - the payload type.

Parameters:

links - must not be null.

Returns:

will never be null.

empty

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

Creates an empty SlicedModel with the given links.

Type Parameters:

T - the payload type.

Parameters:

links - must not be null.

Returns:

will never be null.

empty

public static <T> SlicedModel<T> empty(@Nullable
 SlicedModel.SliceMetadata metadata)

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata.

Type Parameters:

T - the payload type.

Parameters:

metadata - can be null.

Returns:

will never be null.

empty

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

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.

Type Parameters:

T - the payload type.

Parameters:

metadata - can be null.

fallbackType - must not be null.

generics - must not be null.

Returns:

will never be null.

See Also:

• withFallbackType(Class, Class...)

empty

public static <T> SlicedModel<T> empty(@Nullable
 SlicedModel.SliceMetadata metadata,
 ParameterizedTypeReference<T> fallbackType)

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.

Type Parameters:

T - the payload type.

Parameters:

metadata - can be null.

Returns:

will never be null.

See Also:

• withFallbackType(ParameterizedTypeReference)

empty

public static <T> SlicedModel<T> empty(@Nullable
 SlicedModel.SliceMetadata metadata,
 ResolvableType fallbackType)

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and fallback type.

Type Parameters:

T -

Parameters:

metadata - can be null.

fallbackType - must not be null.

Returns:

See Also:

• withFallbackType(ResolvableType)

empty

public static <T> SlicedModel<T> empty(@Nullable
 SlicedModel.SliceMetadata metadata,
 Link... links)

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.

Type Parameters:

T -

Parameters:

metadata - can be null.

links - must not be null.

Returns:

empty

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

Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.

Type Parameters:

T - the payload type.

Parameters:

metadata - can be null.

links - must not be null.

Returns:

will never be null.

of

public static <T> SlicedModel<T> of(Collection<T> content,
 @Nullable
 SlicedModel.SliceMetadata metadata)

Creates a new SlicedModel from the given content, SlicedModel.SliceMetadata and Links (optional).

Type Parameters:

T - the payload type.

Parameters:

content - must not be null.

metadata - can be null.

Returns:

will never be null.

of

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

Creates a new SlicedModel from the given content, SlicedModel.SliceMetadata and Links (optional).

Type Parameters:

T - the payload type.

Parameters:

content - must not be null.

metadata - can be null.

links - must not be null.

Returns:

will never be null.

of

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

Creates a new SlicedModel from the given content SlicedModel.SliceMetadata and Links.

Type Parameters:

T - the payload type.

Parameters:

content - must not be null.

metadata - can be null.

links - must not be null.

Returns:

will never be null.

wrap

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

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

Type Parameters:

T - the nested EntityModel type.

S - the actual payload type.

Parameters:

content - must not be null.

metadata -

Returns:

will never be null.

getMetadata

@Nullable
public SlicedModel.SliceMetadata getMetadata()

Returns the pagination metadata.

Returns:

the metadata can be null.

getNextLink

public Optional<Link> getNextLink()

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

Returns:

will never be null.

getPreviousLink

public Optional<Link> getPreviousLink()

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

Returns:

will never be null.

withFallbackType

public SlicedModel<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 SlicedModel<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 SlicedModel<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>