Package com.abubusoft.kripton.androidx.livedata

Class PagedLiveData<T>

java.lang.Object

androidx.lifecycle.LiveData<T>

androidx.lifecycle.MutableLiveData<T>

com.abubusoft.kripton.androidx.livedata.KriptonXLiveData<T>

com.abubusoft.kripton.androidx.livedata.PagedLiveData<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

PagedResult, PageNavigator, PageRequest

public abstract class PagedLiveData<T>
extends KriptonXLiveData<T>
implements PagedResult

The paged version of KriptonLiveData.

Author:

Francesco Benincasa (info@abubusoft.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PagedLiveData.PageRequestBuilder	This builder allows you to manipulate page request object, changing some its attributes and invoke an unique update to live date.

Constructor Summary

Constructors

Constructor	Description
PagedLiveData(Paginator<T> pageRequest, KriptonXPagedLiveDataHandlerImpl<T> handler)

Method Summary

Modifier and Type	Method	Description
PagedLiveData.PageRequestBuilder	createPageRequestBuilder()	Allows to create a builder for a page request.
void	firstPage()	Navigate to the first page.
PageRequestExecutor<T>	getExecutor()
int	getOffset()	Set the current offset from start of dataset.
int	getPageNumber()	Current page
int	getPageSize()	Page size used to navigate
int	getTotalElements()	Returns the total amount of elements.
int	getTotalPages()	Returns the number of total pages.
boolean	hasNext()
boolean	hasPrevious()
boolean	isFirst()
boolean	isLast()
void	lastPage()	Navigate to last page
void	nextPage()	Navigates to next page.
void	previousPage()	Navigates to previous page.
void	setOffset(int offset)	Navigates to the offset.
void	setPage(int page)	Navigates to the page.
void	setPageSize(int pageSize)	Set page size

Methods inherited from class com.abubusoft.kripton.androidx.livedata.KriptonXLiveData

updateValue

Methods inherited from class androidx.lifecycle.MutableLiveData

postValue, setValue

Methods inherited from class androidx.lifecycle.LiveData

getValue, hasActiveObservers, hasObservers, observe, observeForever, onActive, onInactive, removeObserver, removeObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

PagedLiveData

public PagedLiveData(Paginator<T> pageRequest,
                     KriptonXPagedLiveDataHandlerImpl<T> handler)

Method Detail

createPageRequestBuilder

public PagedLiveData.PageRequestBuilder createPageRequestBuilder()

Allows to create a builder for a page request. This builder is usefully when you need to modify different parameter of page request and you want to make only a page request.

Returns:

getExecutor

public PageRequestExecutor<T> getExecutor()

getPageNumber

public int getPageNumber()

Description copied from interface: PageRequest

Current page

Specified by:

getPageNumber in interface PageRequest

Returns:

Current page

getPageSize

public int getPageSize()

Description copied from interface: PageRequest

Page size used to navigate

Specified by:

getPageSize in interface PageRequest

Returns:

Page size used to navigate

setPage

public void setPage(int page)

Description copied from interface: PageNavigator

Navigates to the page. This method is an alternative to offset.

Specified by:

setPage in interface PageNavigator

nextPage

public void nextPage()

Description copied from interface: PageNavigator

Navigates to next page.

Specified by:

nextPage in interface PageNavigator

setOffset

public void setOffset(int offset)

Description copied from interface: PageNavigator

Navigates to the offset. This method is an alternative to page.

Specified by:

setOffset in interface PageNavigator

previousPage

public void previousPage()

Description copied from interface: PageNavigator

Navigates to previous page.

Specified by:

previousPage in interface PageNavigator

firstPage

public void firstPage()

Description copied from interface: PageNavigator

Navigate to the first page.

Specified by:

firstPage in interface PageNavigator

getOffset

public int getOffset()

Description copied from interface: PageRequest

Set the current offset from start of dataset.

Specified by:

getOffset in interface PageRequest

Returns:

setPageSize

public void setPageSize(int pageSize)

Description copied from interface: PageNavigator

Set page size

Specified by:

setPageSize in interface PageNavigator

getTotalElements

public int getTotalElements()

Description copied from interface: PagedResult

Returns the total amount of elements.

Specified by:

getTotalElements in interface PagedResult

Returns:

the total amount of elements

lastPage

public void lastPage()

Description copied from interface: PageNavigator

Navigate to last page

Specified by:

lastPage in interface PageNavigator

getTotalPages

public int getTotalPages()

Description copied from interface: PagedResult

Returns the number of total pages.

Specified by:

getTotalPages in interface PagedResult

Returns:

the number of total pages

isLast

public boolean isLast()

Specified by:

isLast in interface PagedResult

isFirst

public boolean isFirst()

Specified by:

isFirst in interface PagedResult

hasNext

public boolean hasNext()

Specified by:

hasNext in interface PagedResult

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface PagedResult