クラス PageableHandlerMethodArgumentResolverSupport

メソッドの詳細

• setFallbackPageable

  public void setFallbackPageable(Pageable fallbackPageable)

  解決するメソッドパラメーターで PageableDefault が見つからない場合に、フォールバックとして使用されるように Pageable を構成します。

  これを Pageable#unpaged() に設定した場合、リクエストで Pageable データが見つからない場合に備えて、コントローラーメソッドが unpaged インスタンスを取得することに注意してください。

  パラメーター:

  fallbackPageable - 一般的なフォールバックとして使用される Pageable。

• isFallbackPageable

  public boolean isFallbackPageable(Pageable pageable)

  指定された Pageable がフォールバックであるかどうかを返します。

  パラメーター:

  pageable - null でもかまいません。

  戻り値:

• setMaxPageSize

  public void setMaxPageSize(int maxPageSize)

  受け入れる最大ページサイズを設定します。これにより、ページサイズの上限を設定して、OutOfMemoryErrorSE を発行しようとする潜在的な攻撃を防ぐことができます。デフォルトは DEFAULT_MAX_PAGE_SIZE です。

  パラメーター:

  maxPageSize - 設定する maxPageSize

• getMaxPageSize

  protected int getMaxPageSize()

  受け入れられる最大ページサイズを取得します。これにより、ページサイズの上限を設定して、OutOfMemoryErrorSE を発行しようとする潜在的な攻撃を防ぐことができます。デフォルトは DEFAULT_MAX_PAGE_SIZE です。

  戻り値:

  許容される最大ページサイズ。

• setPageParameterName

  public void setPageParameterName(StringSE pageParameterName)

  リクエストでページ番号を見つけるために使用されるパラメーター名を構成します。デフォルトは page です。

  パラメーター:

  pageParameterName - 使用するパラメーター名。null または空であってはなりません。

• getPageParameterName

  protected StringSE getPageParameterName()

  リクエストでページ番号を見つけるために使用されるパラメーター名を取得します。デフォルトは page です。

  戻り値:

  使用するパラメーター名。null または空にはできません。

• setSizeParameterName

  public void setSizeParameterName(StringSE sizeParameterName)

  リクエストでページサイズを見つけるために使用されるパラメーター名を設定します。デフォルトは size です。

  パラメーター:

  sizeParameterName - 使用するパラメーター名。null または空であってはなりません。

• getSizeParameterName

  protected StringSE getSizeParameterName()

  リクエストでページサイズを見つけるために使用されるパラメーター名を取得します。デフォルトは size です。

  戻り値:

  使用するパラメーター名。null または空にはできません。

• setPrefix

  public void setPrefix(@Nullable StringSE prefix)

  ページ番号とページサイズのパラメーターの前に付加する一般的なプレフィックスを構成します。アプリケーションで使用されているプロパティ名と競合する場合に使用されるプロパティ名に名前空間を付けるのに役立ちます。デフォルトでは、プレフィックスは使用されません。

  パラメーター:

  prefix - 使用する接頭辞、またはデフォルトにリセットする場合は null。

• setQualifierDelimiter

  public void setQualifierDelimiter(@Nullable StringSE qualifierDelimiter)

  修飾子と実際のページ番号およびサイズプロパティの間に使用される区切り文字。デフォルトは _ です。foo の修飾子は、foo_page のページ番号パラメーターになります。

  パラメーター:

  qualifierDelimiter - 使用する区切り文字、またはデフォルトにリセットする場合は null

• setOneIndexedParameters

  public void setOneIndexedParameters(boolean oneIndexedParameters)

  リクエストパラメーターで 1 から始まるページ番号インデックスを公開して想定するかどうかを構成します。デフォルトは false です。つまり、リクエストのページ番号 0 は最初のページと同じです。これが true に設定されている場合、リクエストのページ番号 1 は最初のページと見なされます。

  パラメーター:

  oneIndexedParameters - 設定する oneIndexedParameters

• isOneIndexedParameters

  protected boolean isOneIndexedParameters()

  リクエストパラメーターで 1 から始まるページ番号インデックスを公開して想定するかどうかを示します。デフォルトは false です。つまり、リクエストのページ番号 0 は最初のページと同じです。これが true に設定されている場合、リクエストのページ番号 1 は最初のページと見なされます。

  戻り値:

  リクエストパラメーターで 1 から始まるページ番号インデックスを想定するかどうか。

• getPageable

  protected Pageable getPageable(MethodParameter methodParameter, @Nullable StringSE pageString, @Nullable StringSE pageSizeString)

• getParameterNameToUse

  protected StringSE getParameterNameToUse(StringSE source, @Nullable MethodParameter parameter)

  Pageable 情報を検索するためのリクエストパラメーターの名前を返します。Qualifier が存在するかどうか、指定された MethodParameter をインスペクションし、指定されたソースパラメーター名にプレフィックスを付けます。

  パラメーター:

  source - 基本的なパラメーター名。

  parameter - MethodParameter は認定されている可能性があります。

  戻り値:

  リクエストパラメーターの名前。