Package org.springframework.hateoas

Class CollectionModel<T>

java.lang.Object

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

org.springframework.hateoas.CollectionModel<T>

All Implemented Interfaces:

Iterable<T>, ResolvableTypeProvider

Direct Known Subclasses:

CollectionModelMixin, PagedModel, SlicedModel, VndErrors

public class CollectionModel<T>
extends RepresentationModel<CollectionModel<T>>
implements Iterable<T>, ResolvableTypeProvider

General helper to easily create a wrapper for a collection of entities.

Author:

Oliver Gierke, Greg Turnquist

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CollectionModel()	Creates an empty CollectionModel instance.
protected	CollectionModel(Iterable<T> content)
protected	CollectionModel(Iterable<T> content, Iterable<Link> links, ResolvableType fallbackType)

Method Summary

Modifier and Type	Method	Description
static <T> CollectionModel<T>	empty()	Creates a new empty collection model.
static <T> CollectionModel<T>	empty(Class<T> elementType, Class<?>... generics)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	empty(Iterable<Link> links)	Creates a new empty collection model with the given links.
static <T> CollectionModel<T>	empty(ParameterizedTypeReference<T> type)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	empty(ResolvableType elementType)	Creates a new empty collection model with the given type defined as fallback type.
static <T> CollectionModel<T>	empty(Link... links)	Creates a new empty collection model with the given links.
boolean	equals(Object obj)
Collection<T>	getContent()	Returns the underlying elements.
ResolvableType	getResolvableType()
int	hashCode()
Iterator<T>	iterator()
static <T> CollectionModel<T>	of(Iterable<T> content)	Creates a CollectionModel instance with the given content.
static <T> CollectionModel<T>	of(Iterable<T> content, Iterable<Link> links)	s Creates a CollectionModel instance with the given content and Links.
static <T> CollectionModel<T>	of(Iterable<T> content, Link... links)	Creates a CollectionModel instance with the given content and Links (optional).
String	toString()
CollectionModel<T>	withFallbackType(Class<? super T> type, Class<?>... generics)	Declares the given type as fallback element type in case the underlying collection is empty.
CollectionModel<T>	withFallbackType(ParameterizedTypeReference<?> type)	Declares the given type as fallback element type in case the underlying collection is empty.
CollectionModel<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> CollectionModel<T>	wrap(Iterable<S> content)	Creates a new CollectionModel instance by wrapping the given domain class instances into a EntityModel.

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

Constructor Details

CollectionModel

protected CollectionModel()

Creates an empty CollectionModel instance.

CollectionModel

protected CollectionModel(Iterable<T> content)

CollectionModel

protected CollectionModel(Iterable<T> content,
 Iterable<Link> links,
 @Nullable
 ResolvableType fallbackType)

Method Details

empty

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

Creates a new empty collection model.

Type Parameters:

T -

Returns:

Since:

1.1

empty

public static <T> CollectionModel<T> empty(Class<T> elementType,
 Class<?>... generics)

Creates a new empty collection model with the given type defined as fallback type.

Type Parameters:

T -

Returns:

Since:

1.4

See Also:

• withFallbackType(Class, Class...)

empty

public static <T> CollectionModel<T> empty(ParameterizedTypeReference<T> type)

Creates a new empty collection model with the given type defined as fallback type.

Type Parameters:

T -

Returns:

Since:

1.4

See Also:

• withFallbackType(ParameterizedTypeReference)

empty

public static <T> CollectionModel<T> empty(ResolvableType elementType)

Creates a new empty collection model with the given type defined as fallback type.

Type Parameters:

T -

Returns:

Since:

1.4

See Also:

• withFallbackType(ResolvableType)

empty

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

Creates a new empty collection model with the given links.

Type Parameters:

T -

Parameters:

links - must not be null.

Returns:

Since:

1.1

empty

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

Creates a new empty collection model with the given links.

Type Parameters:

T -

Parameters:

links - must not be null.

Returns:

Since:

1.1

of

public static <T> CollectionModel<T> of(Iterable<T> content)

Creates a CollectionModel instance with the given content.

Parameters:

content - must not be null.

Returns:

Since:

1.1

See Also:

• withFallbackType(Class, Class...)
• withFallbackType(ResolvableType)

of

public static <T> CollectionModel<T> of(Iterable<T> content,
 Link... links)

Creates a CollectionModel instance with the given content and Links (optional).

Parameters:

content - must not be null.

links - the links to be added to the CollectionModel.

Returns:

Since:

1.1

See Also:

• withFallbackType(Class, Class...)
• withFallbackType(ResolvableType)

of

public static <T> CollectionModel<T> of(Iterable<T> content,
 Iterable<Link> links)

s Creates a CollectionModel instance with the given content and Links.

Parameters:

content - must not be null.

links - the links to be added to the CollectionModel.

Returns:

Since:

1.1

See Also:

• withFallbackType(Class, Class...)
• withFallbackType(ResolvableType)

wrap

public static <T extends EntityModel<S>,
S>
CollectionModel<T> wrap(Iterable<S> content)

Creates a new CollectionModel instance by wrapping the given domain class instances into a EntityModel.

Parameters:

content - must not be null.

Returns:

getContent

public Collection<T> getContent()

Returns the underlying elements.

Returns:

the content will never be null.

withFallbackType

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

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.

Parameters:

type - must not be null.

Returns:

will never be null.

Since:

1.4

withFallbackType

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

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.

Parameters:

type - must not be null.

Returns:

will never be null.

Since:

1.4

withFallbackType

public CollectionModel<T> withFallbackType(ResolvableType type)

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.

Parameters:

type - must not be null.

Returns:

will never be null.

Since:

1.4

getResolvableType

@NonNull
public ResolvableType getResolvableType()

Specified by:

getResolvableType in interface ResolvableTypeProvider

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

toString

public String toString()

Overrides:

toString in class RepresentationModel<CollectionModel<T>>

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class RepresentationModel<CollectionModel<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class RepresentationModel<CollectionModel<T>>