クラス PagedModel<T>
java.lang.ObjectSE
org.springframework.hateoas.RepresentationModel<CollectionModel<T>>
org.springframework.hateoas.CollectionModel<T>
org.springframework.hateoas.PagedModel<T>
- 実装されたすべてのインターフェース:
IterableSE<T>
,ResolvableTypeProvider
ページング可能なコレクションのバインディングレスポンス表現を実装するための DTO。
- 作成者:
- Oliver Gierke, Greg Turnquist
ネストされたクラスのサマリー
ネストされたクラスフィールドのサマリー
フィールドコンストラクターの概要
コンストラクター修飾子コンストラクター説明protected
リフレクションによるインスタンス化を許可するデフォルトのコンストラクター。protected
PagedModel
(CollectionSE<T> content, PagedModel.PageMetadata metadata) protected
PagedModel
(CollectionSE<T> content, PagedModel.PageMetadata metadata, IterableSE<Link> links) protected
PagedModel
(CollectionSE<T> content, PagedModel.PageMetadata metadata, IterableSE<Link> links, ResolvableType fallbackType) メソッドのサマリー
修飾子と型メソッド説明static <T> PagedModel<T>
empty()
空のPagedModel
を作成します。static <T> PagedModel<T>
指定されたフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(IterableSE<Link> links) 指定されたリンクで空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(ParameterizedTypeReference<T> fallbackElementType) 指定されたフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(ResolvableType fallbackElementType) 指定されたフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
指定されたリンクで空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata) 指定されたPagedModel.PageMetadata
で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata, ClassSE<?> fallbackType, ClassSE<?>... generics) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata, IterableSE<Link> links) 指定されたPagedModel.PageMetadata
とリンクで空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata, ParameterizedTypeReference<T> fallbackType) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata, ResolvableType fallbackType) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。static <T> PagedModel<T>
empty
(PagedModel.PageMetadata metadata, Link... links) 指定されたPagedModel.PageMetadata
とリンクで空のPagedModel
を作成します。boolean
ページネーションのメタデータを返します。次のページへのリンクを返します (設定されている場合)。前のページを指すリンクを返します (設定されている場合)。int
hashCode()
static <T> PagedModel<T>
of
(CollectionSE<T> content, PagedModel.PageMetadata metadata) static <T> PagedModel<T>
of
(CollectionSE<T> content, PagedModel.PageMetadata metadata, IterableSE<Link> links) static <T> PagedModel<T>
of
(CollectionSE<T> content, PagedModel.PageMetadata metadata, Link... links) toString()
withFallbackType
(ClassSE<? super T> type, ClassSE<?>... generics) 基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。static <T extends EntityModel<S>,
S>
PagedModel<T>wrap
(IterableSE<S> content, PagedModel.PageMetadata metadata) 一連のエンティティとページネーションメタデータからPagedModel
インスタンスを簡単に作成するファクトリメソッド。クラス org.springframework.hateoas.CollectionModel から継承されたメソッド
empty, getContent, getResolvableType, iterator, of, of, of, wrap
クラス org.springframework.hateoas.RepresentationModel から継承されたメソッド
add, add, add, addAllIf, addIf, getLink, getLink, getLinks, getLinks, getLinks, getRequiredLink, getRequiredLink, hasLink, hasLink, hasLinks, mapLink, mapLinkIf, of, of, removeLinks
クラス java.lang.ObjectSE から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE
インターフェース java.lang.IterableSE から継承されたメソッド
forEachSE, spliterator
フィールドの詳細
NO_PAGE
コンストラクターの詳細
PagedModel
protected PagedModel()リフレクションによるインスタンス化を許可するデフォルトのコンストラクター。PagedModel
PagedModel
protected PagedModel(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) PagedModel
protected PagedModel(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links, @Nullable ResolvableType fallbackType)
メソッドの詳細
empty
空のPagedModel
を作成します。- 型パラメーター:
T
-- 戻り値:
- null になることはありません。
- 導入:
- 1.1
empty
指定されたフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
fallbackElementType
- null であってはなりません。generics
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.4
- 関連事項:
empty
指定されたフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
fallbackElementType
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.4
- 関連事項:
empty
指定されたフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
fallbackElementType
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.4
- 関連事項:
empty
指定されたリンクで空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
links
- null であってはなりません。- 戻り値:
- 導入:
- 1.1
empty
指定されたリンクで空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
links
- null であってはなりません。- 戻り値:
- 導入:
- 1.1
empty
指定されたPagedModel.PageMetadata
で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。- 戻り値:
- 導入:
- 1.1
empty
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, ClassSE<?> fallbackType, ClassSE<?>... generics) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。fallbackType
- null であってはなりません。generics
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.4
- 関連事項:
empty
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, ParameterizedTypeReference<T> fallbackType) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。- 戻り値:
- 導入:
- 1.4
- 関連事項:
empty
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, ResolvableType fallbackType) 指定されたPagedModel.PageMetadata
とフォールバック型で空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。fallbackType
- null であってはなりません。- 戻り値:
- 導入:
- 1.4
- 関連事項:
empty
指定されたPagedModel.PageMetadata
とリンクで空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。links
- null であってはなりません。- 戻り値:
- 導入:
- 1.1
empty
public static <T> PagedModel<T> empty(@Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) 指定されたPagedModel.PageMetadata
とリンクで空のPagedModel
を作成します。- 型パラメーター:
T
-- パラメーター:
metadata
- null でもかまいません。links
- null であってはなりません。- 戻り値:
- 導入:
- 1.1
of
public static <T> PagedModel<T> of(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata) - パラメーター:
content
- null であってはなりません。metadata
- null でもかまいません。- 戻り値:
- null になることはありません。
of
public static <T> PagedModel<T> of(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, Link... links) - パラメーター:
content
- null であってはなりません。metadata
- null でもかまいません。links
- null であってはなりません。- 戻り値:
- null になることはありません。
of
public static <T> PagedModel<T> of(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) - パラメーター:
content
- null であってはなりません。metadata
- null でもかまいません。links
- null であってはなりません。
getMetadata
ページネーションのメタデータを返します。- 戻り値:
- メタデータ
wrap
public static <T extends EntityModel<S>,S> PagedModel<T> wrap(IterableSE<S> content, PagedModel.PageMetadata metadata) 一連のエンティティとページネーションメタデータからPagedModel
インスタンスを簡単に作成するファクトリメソッド。- パラメーター:
content
- null であってはなりません。metadata
-- 戻り値:
getNextLink
次のページへのリンクを返します (設定されている場合)。- 戻り値:
getPreviousLink
前のページを指すリンクを返します (設定されている場合)。- 戻り値:
withFallbackType
クラスからコピーされた説明:CollectionModel
基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。これにより、クライアントコンポーネントは引き続き実行時に型の一致を適用できます。- オーバーライド:
- クラス
CollectionModel<T>
のwithFallbackType
- パラメーター:
type
- null であってはなりません。- 戻り値:
- null になることはありません。
withFallbackType
クラスからコピーされた説明:CollectionModel
基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。これにより、クライアントコンポーネントは引き続き実行時に型の一致を適用できます。- オーバーライド:
- クラス
CollectionModel<T>
のwithFallbackType
- パラメーター:
type
- null であってはなりません。- 戻り値:
- null になることはありません。
withFallbackType
クラスからコピーされた説明:CollectionModel
基になるコレクションが空の場合に備えて、指定された型をフォールバック要素型として宣言します。これにより、クライアントコンポーネントは引き続き実行時に型の一致を適用できます。- オーバーライド:
- クラス
CollectionModel<T>
のwithFallbackType
- パラメーター:
type
- null であってはなりません。- 戻り値:
- null になることはありません。
toString
- オーバーライド:
- クラス
CollectionModel<T>
のtoString
equals
- オーバーライド:
- クラス
CollectionModel<T>
のequals
hashCode
public int hashCode()- オーバーライド:
- クラス
CollectionModel<T>
のhashCode