Package com.helixframework.api.contract

Class HateoasCursorPaginatedResponse<T>

java.lang.Object

com.helixframework.api.contract.HateoasResponse

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

Type Parameters:

T - item type

public class HateoasCursorPaginatedResponse<T>
extends HateoasResponse

API response that returns a collection with cursor pagination and HATEOS links.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the number of items in the collection.
String	getCursor()	Gets the next page cursor.
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

HateoasCursorPaginatedResponse

public HateoasCursorPaginatedResponse()

Creates an instance of HateoasCursorPaginatedResponse.

HateoasCursorPaginatedResponse

public HateoasCursorPaginatedResponse(String cursor,
 Collection<T> items)

Creates an instance of HateoasCursorPaginatedResponse without links.

Parameters:

cursor - next page cursor

items - items to return in response

HateoasCursorPaginatedResponse

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

Creates an instance of HateoasCursorPaginatedResponse with links.

Parameters:

cursor - next page cursor

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

getCursor

public String getCursor()

Gets the next page cursor.

Returns:

next page cursor

getItems

public Collection<T> getItems()

Gets the items.

Returns:

items