インターフェース Pageable

メソッドの詳細

• unpaged

  static Pageable unpaged()

  ページ設定がないことを表す Pageable インスタンスを返します。

• unpaged

  static Pageable unpaged(Sort sort)

  定義された結果 order を持つページネーション設定がないことを表す Pageable インスタンスを返します。

  パラメーター:

  sort - null であってはなりません。必要に応じて Sort.unsorted() を使用してください。

  戻り値:

  指定された Sort 順序を考慮したページング設定がないことを表す、ページングされていない Pageable インスタンス。

  導入:

  3.2

• ofSize

  static Pageable ofSize(int pageSize)

  pageSize を指定して、最初のページ（ページ番号 0）の新しい Pageable を作成します。

  パラメーター:

  pageSize - 返されるページのサイズは 0 より大きい必要があります。

  戻り値:

  新しい Pageable。

  導入:

  2.5

• isPaged

  default boolean isPaged()

  現在の Pageable にページ分割情報が含まれているかどうかを返します。

  戻り値:

  現在の Pageable にページ区切り情報が含まれている場合は true です。

• isUnpaged

  default boolean isUnpaged()

  現在の Pageable にページ分割情報が含まれていないかどうかを返します。

  戻り値:

  現在の Pageable にページ区切り情報が含まれていない場合は true です。

• getPageNumber

  int getPageNumber()

  返されるページを返します。

  戻り値:

  返されるページ、またはオブジェクトが isUnpaged() の場合は UnsupportedOperationExceptionSE をスローします。

  例外:

  UnsupportedOperationExceptionSE - オブジェクトが isUnpaged() の場合。

• getPageSize

  int getPageSize()

  返されるアイテムの数を返します。

  戻り値:

  そのページのアイテム数、またはオブジェクトが isUnpaged() の場合は UnsupportedOperationExceptionSE をスローします。

  例外:

  UnsupportedOperationExceptionSE - オブジェクトが isUnpaged() の場合。

• getOffset

  long getOffset()

  基になるページとページサイズに従って取得するオフセットを返します。

  戻り値:

  取得するオフセット、またはオブジェクトが isUnpaged() の場合は UnsupportedOperationExceptionSE をスローします。

  例外:

  UnsupportedOperationExceptionSE - オブジェクトが isUnpaged() の場合。

• getSort

  Sort getSort()

  並べ替えパラメーターを返します。

  戻り値:

  並べ替え順序。

• getSortOr

  default Sort getSortOr(Sort sort)

  現在の Sort、または現在の Sort がソートされていない場合は指定されたものを返します。

  パラメーター:

  sort - null であってはなりません。

  戻り値:

  現在の Sort または、現在の sort がソートされていない場合は、Sort または sort です。

• next

  @Contract("-> new") @CheckReturnValue Pageable next()

  次の Page をリクエストする Pageable を返します。

  戻り値:

  Pageable が次の Page をリクエストします。

• previousOrFirst

  @Contract("-> new") @CheckReturnValue Pageable previousOrFirst()

  前の Pageable または現在の Pageable がすでに最初の Pageable である場合は、最初の Pageable を返します。

  戻り値:

  現在の Pageable がすでに最初の Pageable である場合は、前の Pageable または最初の Pageable。

• first

  @Contract("-> new") @CheckReturnValue Pageable first()

  最初のページをリクエストする Pageable を返します。

  戻り値:

  Pageable が最初のページをリクエストします。

• withPage

  @Contract("_ -> new") @CheckReturnValue Pageable withPage(int pageNumber)

  pageNumber が適用された新しい Pageable を作成します。

  パラメーター:

  pageNumber - ページ番号（ゼロベース）。

  戻り値:

  オブジェクトが isUnpaged() で pageNumber がゼロでない場合、新しい PageRequest または UnsupportedOperationExceptionSE をスローします。

  例外:

  UnsupportedOperationExceptionSE - オブジェクトが isUnpaged() の場合。

  導入:

  2.5

• hasPrevious

  boolean hasPrevious()

  現在の Pageable が現在のものからアクセスできるかどうかを返します。現在の Pageable がすでに最初のページを参照している場合は、false を返します。

  戻り値:

  現在の Pageable からアクセスできる以前の Pageable がある場合は true です。

• toOptional

  default OptionalSE<Pageable> toOptional()

  簡単にマップできるように、OptionalSE を返します。

  戻り値:

  OptionalSE なので簡単にマッピングできます。

• toLimit

  default Limit toLimit()

  ページが is paged または Limit.unlimited() をリクエストした場合は、このページ可能オブジェクトから Limit を返します。

  戻り値:

  現在のページサイズに基づく Limit オブジェクト。

  導入:

  3.2

• toScrollPosition

  default OffsetScrollPosition toScrollPosition()

  ページが is paged をリクエストした場合、このページ可能オブジェクトから OffsetScrollPosition を返します。

  スクロールの排他性を考慮すると、Page(0, 10) の ScrollPosition は initial の位置を変換しますが、Page(1, 10) は Page(0,10) の最後の要素を指し、結果として ScrollPosition(9) になります。

  戻り値:

  OffsetScrollPosition の新しいインスタンス。

  例外:

  IllegalStateExceptionSE - リクエストが isUnpaged() の場合

  導入:

  3.1