Package com.helixframework.api.contract

Class HateoasCollectionResponse<T>

java.lang.Object

com.helixframework.api.contract.HateoasResponse

com.helixframework.api.contract.HateoasCollectionResponse<T>

Type Parameters:

T - item type

public class HateoasCollectionResponse<T>
extends HateoasResponse

API response that returns a collection with HATEOS links.

Constructor Summary

Constructors

Constructor	Description
HateoasCollectionResponse()	Creates an instance of HateoasCollectionResponse.
HateoasCollectionResponse(Collection<T> items)	Creates an instance of HateoasCollectionResponse without links.
HateoasCollectionResponse(Collection<T> items, Map<String,HalLink> links)	Creates an instance of HateoasCollectionResponse with links.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the number of items in the collection.
Collection<T>	getItems()	Gets the items.

Methods inherited from class com.helixframework.api.contract.HateoasResponse

addLink, addLink, addLink, addLinks, getLinks, self

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HateoasCollectionResponse

public HateoasCollectionResponse()

Creates an instance of HateoasCollectionResponse.

HateoasCollectionResponse

public HateoasCollectionResponse(Collection<T> items)

Creates an instance of HateoasCollectionResponse without links.

Parameters:

items - items to return in response

HateoasCollectionResponse

public HateoasCollectionResponse(Collection<T> items,
 Map<String,HalLink> links)

Creates an instance of HateoasCollectionResponse with links.

Parameters:

items - items to return in response

links - hateoas links

Method Details

getCount

public int getCount()

Gets the number of items in the collection.

Returns:

number of items in the collection

getItems

public Collection<T> getItems()

Gets the items.

Returns:

items