io.apimatic.core.types.pagination

Class PageWrapper<I,P>

java.lang.Object

io.apimatic.core.types.pagination.PageWrapper<I,P>

All Implemented Interfaces:

io.apimatic.coreinterfaces.http.response.ApiResponseType<P>

public final class PageWrapper<I,P>
extends Object
implements io.apimatic.coreinterfaces.http.response.ApiResponseType<P>

Method Summary

Modifier and Type	Method and Description
static <I,P> PageWrapper<I,P>	create(io.apimatic.coreinterfaces.http.response.Response response, P page, List<I> items, PaginationStrategy strategy) Create an instance of PageWrapper with provided page and meta data.
String	getCursorInput() Gets the cursor input used for cursor-based pagination.
io.apimatic.coreinterfaces.http.HttpHeaders	getHeaders() Headers of the http response.
List<I>	getItems() Content of the page.
String	getNextLinkInput() Gets the next link input used for link-based pagination.
int	getOffsetInput() Gets the offset input used for offset-based pagination.
int	getPageInput() Gets the page number input used for page-based pagination.
P	getResult() Content of the page.
int	getStatusCode() HTTP Status code of the api response.
boolean	isCursorPagination()
boolean	isLinkPagination()
boolean	isNumberPagination()
boolean	isOffsetPagination()
void	setCursorInput(String cursorInput) Sets the cursor input
void	setNextLinkInput(String nextLinkInput) Sets the next link input
void	setOffsetInput(int offsetInput) Sets the offset input
void	setPageInput(int pageInput) Sets the page input

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <I,P> PageWrapper<I,P> create(io.apimatic.coreinterfaces.http.response.Response response,
                                            P page,
                                            List<I> items,
                                            PaginationStrategy strategy)

Create an instance of PageWrapper with provided page and meta data.

Type Parameters:

I - Represent type of items in the page.

P - Represent type of page.

Parameters:

response - Response from API call.

page - Page to be wrapped.

items - Extracted items from the page.

strategy - Pagination strategy to be applied.

Returns:

An new instance of PageWrapper.

isCursorPagination

public boolean isCursorPagination()

Returns:

True if cursor paginated page is wrapped

isLinkPagination

public boolean isLinkPagination()

Returns:

True if link paginated page is wrapped

isOffsetPagination

public boolean isOffsetPagination()

Returns:

True if offset paginated page is wrapped

isNumberPagination

public boolean isNumberPagination()

Returns:

True if number paginated page is wrapped

setNextLinkInput

public void setNextLinkInput(String nextLinkInput)

Sets the next link input

Parameters:

nextLinkInput - value of next link input

getNextLinkInput

public String getNextLinkInput()

Gets the next link input used for link-based pagination.

Returns:

The next page link

setCursorInput

public void setCursorInput(String cursorInput)

Sets the cursor input

Parameters:

cursorInput - value of cursor input

getCursorInput

public String getCursorInput()

Gets the cursor input used for cursor-based pagination.

Returns:

The cursor token

setOffsetInput

public void setOffsetInput(int offsetInput)

Sets the offset input

Parameters:

offsetInput - value of offset input

getOffsetInput

public int getOffsetInput()

Gets the offset input used for offset-based pagination.

Returns:

The offset value

setPageInput

public void setPageInput(int pageInput)

Sets the page input

Parameters:

pageInput - value of page input

getPageInput

public int getPageInput()

Gets the page number input used for page-based pagination.

Returns:

The page number

getStatusCode

public int getStatusCode()

HTTP Status code of the api response.

Specified by:

getStatusCode in interface io.apimatic.coreinterfaces.http.response.ApiResponseType<P>

Returns:

Int status code

getHeaders

public io.apimatic.coreinterfaces.http.HttpHeaders getHeaders()

Headers of the http response.

Specified by:

getHeaders in interface io.apimatic.coreinterfaces.http.response.ApiResponseType<P>

Returns:

Headers

getResult

public P getResult()

Content of the page.

Specified by:

getResult in interface io.apimatic.coreinterfaces.http.response.ApiResponseType<P>

Returns:

Content

getItems

public List<I> getItems()

Content of the page.

Returns:

List of items on this page.