public abstract class PageableHandlerMethodArgumentResolverSupport extends ObjectSE
Pageable
インスタンスをコントローラーメソッドに挿入できます。解析するリクエストプロパティを設定できます。デフォルトの構成では、DEFAULT_PAGE_PARAMETER
DEFAULT_QUALIFIER_DELIMITER
で始まるリクエストパラメーターを使用します。PageableHandlerMethodArgumentResolver
, ReactivePageableHandlerMethodArgumentResolver
コンストラクターと説明 |
---|
PageableHandlerMethodArgumentResolverSupport() |
修飾子と型 | メソッドと説明 |
---|---|
protected int | getMaxPageSize() 受け入れられる最大ページサイズを取得します。 |
protected Pageable | getPageable(MethodParameter methodParameter, StringSE pageString, StringSE pageSizeString) |
protected StringSE | getPageParameterName() リクエストでページ番号を見つけるために使用されるパラメーター名を取得します。 |
protected StringSE | getParameterNameToUse(StringSE source, MethodParameter parameter) Pageable 情報を検索するリクエストパラメーターの名前を返します。 |
protected StringSE | getSizeParameterName() リクエストでページサイズを見つけるために使用されるパラメーター名を取得します。 |
boolean | isFallbackPageable(Pageable pageable) 指定された Pageable がフォールバックであるかどうかを返します。 |
protected boolean | isOneIndexedParameters() リクエストパラメーターで 1 から始まるページ番号インデックスを公開して想定するかどうかを示します。 |
void | setFallbackPageable(Pageable fallbackPageable) 解決するメソッドパラメーターで PageableDefault または PageableDefault (後者はレガシーモードでのみサポートされています)が見つからない場合に、フォールバックとして使用する Pageable を構成します。 |
void | setMaxPageSize(int maxPageSize) 受け入れられる最大ページサイズを設定します。 |
void | setOneIndexedParameters(boolean oneIndexedParameters) リクエストパラメーターで 1 から始まるページ番号インデックスを公開して想定するかどうかを構成します。 |
void | setPageParameterName(StringSE pageParameterName) リクエストでページ番号を見つけるために使用されるパラメーター名を構成します。 |
void | setPrefix(StringSE prefix) ページ番号とページサイズのパラメーターの前に付加する一般的なプレフィックスを構成します。 |
void | setQualifierDelimiter(StringSE qualifierDelimiter) 修飾子と実際のページ番号およびサイズのプロパティの間に使用される区切り文字。 |
void | setSizeParameterName(StringSE sizeParameterName) リクエストでページサイズを見つけるために使用されるパラメーター名を設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public PageableHandlerMethodArgumentResolverSupport()
public void setFallbackPageable(Pageable fallbackPageable)
PageableDefault
または PageableDefault
(後者はレガシーモードでのみサポートされています)が見つからない場合に、フォールバックとして使用する Pageable
を構成します。 これを Optional#empty() に設定する場合、リクエストで Pageable
データが見つからない場合に備えて、コントローラーメソッドが null をそれらに渡すことに注意してください。使用できるパラメーターのデフォルトがないため、これを行うには、リクエストにボットのページとサイズパラメーターを指定する必要があることに注意してください。
fallbackPageable
- 一般的なフォールバックとして使用される Pageable
。public boolean isFallbackPageable(Pageable pageable)
Pageable
がフォールバックであるかどうかを返します。pageable
- null でもかまいません。public void setMaxPageSize(int maxPageSize)
OutOfMemoryError
SE を発行しようとする潜在的な攻撃を防ぐことができます。デフォルトは DEFAULT_MAX_PAGE_SIZE
です。maxPageSize
- 設定する maxPageSizeprotected int getMaxPageSize()
OutOfMemoryError
SE を発行しようとする潜在的な攻撃を防ぐことができます。デフォルトは DEFAULT_MAX_PAGE_SIZE
です。public void setPageParameterName(StringSE pageParameterName)
page
です。pageParameterName
- 使用するパラメーター名。null または空であってはなりません。protected StringSE getPageParameterName()
page
です。public void setSizeParameterName(StringSE sizeParameterName)
size
です。sizeParameterName
- 使用するパラメーター名。null または空であってはなりません。protected StringSE getSizeParameterName()
size
です。public void setPrefix(StringSE prefix)
prefix
- 使用する接頭辞、またはデフォルトにリセットする場合は null。public void setQualifierDelimiter(StringSE qualifierDelimiter)
_
です。foo
の修飾子は、foo_page
のページ番号パラメーターになります。qualifierDelimiter
- 使用する区切り文字、またはデフォルトにリセットする場合は nullpublic void setOneIndexedParameters(boolean oneIndexedParameters)
oneIndexedParameters
- 設定する oneIndexedParametersprotected boolean isOneIndexedParameters()
protected Pageable getPageable(MethodParameter methodParameter, @Nullable StringSE pageString, @Nullable StringSE pageSizeString)
protected StringSE getParameterNameToUse(StringSE source, @Nullable MethodParameter parameter)
Pageable
情報を検索するためのリクエストパラメーターの名前を返します。Qualifier
が存在するかどうか、指定された MethodParameter
をインスペクションし、指定されたソースパラメーター名にプレフィックスを付けます。source
- 基本的なパラメーター名。parameter
- MethodParameter
は認定されている可能性があります。Copyright © 2011–2022 Pivotal Software, Inc.. All rights reserved.