インターフェース Pageable
- すべての既知の実装クラス:
AbstractPageRequest
、PageRequest
、QPageRequest
public interface Pageable
ページネーション情報の抽象インターフェース。
- 作成者:
- Oliver Gierke, Mark Paluch, Christoph Strobl
メソッドのサマリー
修飾子と型メソッド説明first()
最初のページをリクエストするPageable
を返します。long
基になるページとページサイズに従って取得するオフセットを返します。int
返されるページを返します。int
返されるアイテムの数を返します。getSort()
並べ替えパラメーターを返します。default Sort
boolean
現在のPageable
が現在のものからアクセスできるかどうかを返します。default boolean
isPaged()
現在のPageable
にページ分割情報が含まれているかどうかを返します。default boolean
現在のPageable
にページ分割情報が含まれていないかどうかを返します。next()
static Pageable
ofSize
(int pageSize) default Limit
toLimit()
default OptionalSE<Pageable>
簡単にマップできるように、Optional
SE を返します。default OffsetScrollPosition
ページがis paged
をリクエストした場合、このページ可能オブジェクトからOffsetScrollPosition
を返します。static Pageable
unpaged()
ページ設定がないことを表すPageable
インスタンスを返します。static Pageable
withPage
(int pageNumber) pageNumber
が適用された新しいPageable
を作成します。
メソッドの詳細
unpaged
ページ設定がないことを表すPageable
インスタンスを返します。- 戻り値:
unpaged
- パラメーター:
sort
- null であってはなりません。必要に応じてSort.unsorted()
を使用してください。- 戻り値:
- 決して null にはなりません。
- 導入:
- 3.2
ofSize
- パラメーター:
pageSize
- 返されるページのサイズは 0 より大きい必要があります。- 戻り値:
- 新しい
Pageable
。 - 導入:
- 2.5
isPaged
default boolean isPaged()現在のPageable
にページ分割情報が含まれているかどうかを返します。- 戻り値:
isUnpaged
default boolean isUnpaged()現在のPageable
にページ分割情報が含まれていないかどうかを返します。- 戻り値:
getPageNumber
int getPageNumber()返されるページを返します。- 戻り値:
- 返されるページ、またはオブジェクトが
isUnpaged()
の場合はUnsupportedOperationException
SE をスローします。 - 例外:
UnsupportedOperationExceptionSE
- オブジェクトがisUnpaged()
の場合。
getPageSize
int getPageSize()返されるアイテムの数を返します。- 戻り値:
- そのページのアイテム数、またはオブジェクトが
isUnpaged()
の場合はUnsupportedOperationException
SE をスローします。 - 例外:
UnsupportedOperationExceptionSE
- オブジェクトがisUnpaged()
の場合。
getOffset
long getOffset()基になるページとページサイズに従って取得するオフセットを返します。- 戻り値:
- 取得するオフセット、またはオブジェクトが
isUnpaged()
の場合はUnsupportedOperationException
SE をスローします。 - 例外:
UnsupportedOperationExceptionSE
- オブジェクトがisUnpaged()
の場合。
getSort
Sort getSort()並べ替えパラメーターを返します。- 戻り値:
getSortOr
- パラメーター:
sort
- null であってはなりません。- 戻り値:
next
Pageable next()- 戻り値:
previousOrFirst
Pageable previousOrFirst()- 戻り値:
first
Pageable first()最初のページをリクエストするPageable
を返します。- 戻り値:
withPage
pageNumber
が適用された新しいPageable
を作成します。- パラメーター:
pageNumber
-- 戻り値:
- オブジェクトが
isUnpaged()
でpageNumber
がゼロでない場合、新しいPageRequest
またはUnsupportedOperationException
SE をスローします。 - 例外:
UnsupportedOperationExceptionSE
- オブジェクトがisUnpaged()
の場合。- 導入:
- 2.5
hasPrevious
boolean hasPrevious()- 戻り値:
toOptional
簡単にマップできるように、Optional
SE を返します。- 戻り値:
toLimit
- 戻り値:
- 導入:
- 3.2
toScrollPosition
ページがis paged
をリクエストした場合、このページ可能オブジェクトからOffsetScrollPosition
を返します。スクロールの排他性を考慮すると、
Page(0, 10)
のScrollPosition
はinitial
の位置を変換しますが、Page(1, 10)
はPage(0,10)
の最後の要素を指すため、ScrollPosition(9)
になります。- 戻り値:
OffsetScrollPosition
の新しいインスタンス。- 例外:
IllegalStateExceptionSE
- リクエストがisUnpaged()
の場合- 導入:
- 3.1