Package com.blazebit.persistence.deltaspike.data

Class KeysetPageRequest

java.lang.Object

com.blazebit.persistence.deltaspike.data.PageRequest

com.blazebit.persistence.deltaspike.data.KeysetPageRequest

All Implemented Interfaces:

KeysetPageable, Pageable, Serializable

public class KeysetPageRequest
extends PageRequest
implements KeysetPageable

Like PageRequest but with support for keyset pagination.

Since:

1.2.0

Author:

Christian Beikov

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeysetPageRequest(int page, int pageSize, com.blazebit.persistence.KeysetPage keysetPage, Sort sort)	Construct a page request with an optional keyset page that may be used for keyset pagination.
KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage, Pageable pageable)	Construct a page request from a pageable with an optional keyset page that may be used for keyset pagination.
KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage, Sort sort)	Construct a page request representing the current page via a keyset page and a sort specification.
KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage, Sort sort, int offset, int pageSize)	Construct a page request with an optional keyset page that may be used for keyset pagination.
KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage, Sort sort, int offset, int pageSize, boolean withCountQuery, boolean withExtractAllKeysets)	Construct a page request with an optional keyset page that may be used for keyset pagination and flags to enable the count query and keyset extraction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
KeysetPageable	first()	Returns the Pageable that can be used to request the first Page.
com.blazebit.persistence.KeysetPage	getKeysetPage()	Returns the keyset page information.
int	hashCode()
boolean	isWithCountQuery()	Returns whether count query execution is enabled or not.
boolean	isWithExtractAllKeysets()	Returns whether extraction for all keysets is enabled or not.
KeysetPageable	next()	Returns the Pageable that can be used to request the next Page.
KeysetPageable	previous()	Returns the Pageable that can be used to request the previous Page or null if the current one already is the first one.
KeysetPageable	previousOrFirst()	Returns the Pageable that can be used to request the previous Page or the first if the current one already is the first one.

Methods inherited from class com.blazebit.persistence.deltaspike.data.PageRequest

getOffset, getPageNumber, getPageSize, getSort, hasPrevious, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.blazebit.persistence.deltaspike.data.Pageable

getOffset, getPageNumber, getPageSize, getSort, hasPrevious

Constructor Detail

KeysetPageRequest

public KeysetPageRequest(int page,
                         int pageSize,
                         com.blazebit.persistence.KeysetPage keysetPage,
                         Sort sort)

Construct a page request with an optional keyset page that may be used for keyset pagination.

Parameters:

page - The page number, 0-based

pageSize - The number of elements per page

keysetPage - The keyset page

sort - The sort specification

KeysetPageRequest

public KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage,
                         Pageable pageable)

Construct a page request from a pageable with an optional keyset page that may be used for keyset pagination.

Parameters:

keysetPage - The keyset page

pageable - The pageable

KeysetPageRequest

public KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage,
                         Sort sort)

Construct a page request representing the current page via a keyset page and a sort specification.

Parameters:

keysetPage - The keyset page

sort - The sort specification

KeysetPageRequest

public KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage,
                         Sort sort,
                         int offset,
                         int pageSize)

Construct a page request with an optional keyset page that may be used for keyset pagination.

Parameters:

keysetPage - The keyset page

sort - The sort specification

offset - The offset number, 0-based

pageSize - The number of elements per page

Since:

1.3.0

KeysetPageRequest

public KeysetPageRequest(com.blazebit.persistence.KeysetPage keysetPage,
                         Sort sort,
                         int offset,
                         int pageSize,
                         boolean withCountQuery,
                         boolean withExtractAllKeysets)

Construct a page request with an optional keyset page that may be used for keyset pagination and flags to enable the count query and keyset extraction.

Parameters:

keysetPage - The keyset page

sort - The sort specification

offset - The offset number, 0-based

pageSize - The number of elements per page

withCountQuery - True to enable the count query

withExtractAllKeysets - True to enable extraction of all keysets

Since:

1.4.0

Method Detail

isWithCountQuery

public boolean isWithCountQuery()

Description copied from interface: KeysetPageable

Returns whether count query execution is enabled or not.

Specified by:

isWithCountQuery in interface KeysetPageable

Returns:

true when enabled, false otherwise

isWithExtractAllKeysets

public boolean isWithExtractAllKeysets()

Description copied from interface: KeysetPageable

Returns whether extraction for all keysets is enabled or not.

Specified by:

isWithExtractAllKeysets in interface KeysetPageable

Returns:

true when enabled, false otherwise

getKeysetPage

public com.blazebit.persistence.KeysetPage getKeysetPage()

Description copied from interface: KeysetPageable

Returns the keyset page information.

Specified by:

getKeysetPage in interface KeysetPageable

Returns:

The keyset page

next

public KeysetPageable next()

Description copied from interface: Pageable

Returns the Pageable that can be used to request the next Page.

Specified by:

next in interface KeysetPageable

Specified by:

next in interface Pageable

Overrides:

next in class PageRequest

Returns:

The Pageable for the next Page

previous

public KeysetPageable previous()

Description copied from interface: Pageable

Returns the Pageable that can be used to request the previous Page or null if the current one already is the first one.

Specified by:

previous in interface KeysetPageable

Specified by:

previous in interface Pageable

Overrides:

previous in class PageRequest

Returns:

The Pageable for the previous Page

previousOrFirst

public KeysetPageable previousOrFirst()

Description copied from interface: Pageable

Returns the Pageable that can be used to request the previous Page or the first if the current one already is the first one.

Specified by:

previousOrFirst in interface KeysetPageable

Specified by:

previousOrFirst in interface Pageable

Overrides:

previousOrFirst in class PageRequest

Returns:

The Pageable for the previous or first Page

first

public KeysetPageable first()

Description copied from interface: Pageable

Returns the Pageable that can be used to request the first Page.

Specified by:

first in interface KeysetPageable

Specified by:

first in interface Pageable

Overrides:

first in class PageRequest

Returns:

The Pageable for the first Page

equals

public boolean equals(Object o)

Overrides:

equals in class PageRequest

hashCode

public int hashCode()

Overrides:

hashCode in class PageRequest