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>

Direct Known Subclasses:

PagedModel, VndErrors

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

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

Author:

Oliver Gierke, Greg Turnquist

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionModel() Creates an empty CollectionModel instance.
	CollectionModel(Iterable<T> content, Iterable<Link> links) Deprecated. since 1.1, use of(Iterable, Iterable) instead.
	CollectionModel(Iterable<T> content, Link... links) Deprecated. since 1.1, use of(Iterable, Link...) instead.

Method Summary

Modifier and Type	Method and Description
static <T> CollectionModel<T>	empty() Creates a new empty collection model.
static <T> CollectionModel<T>	empty(Iterable<Link> links) Creates a new empty collection model with the given links.
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.
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()
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, 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 Detail

CollectionModel

protected CollectionModel()

Creates an empty CollectionModel instance.

CollectionModel

@Deprecated
public CollectionModel(Iterable<T> content,
                                   Link... links)

Deprecated. since 1.1, use of(Iterable, Link...) instead.

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.

CollectionModel

@Deprecated
public CollectionModel(Iterable<T> content,
                                   Iterable<Link> links)

Deprecated. since 1.1, use of(Iterable, Iterable) instead.

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.

Method Detail

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(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

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

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

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.

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