インターフェース EntityLinks
- すべてのスーパーインターフェース:
org.springframework.plugin.core.Plugin<ClassSE<?>>
エンティティ型をサポートするコントローラーを指すリンクへのアクセサー。宣言されたメソッドによってスローされる可能性のある
IllegalArgumentException
SE は、Plugin#supports(Class)
メソッドが false を返し、そのメソッドが呼び出された場合にのみ表示されます。つまり、Plugin#supports(Class)
が true を返した場合、インターフェースメソッドを安全に呼び出すことができ、例外は決してスローされません。- 作成者:
- Oliver Gierke
メソッドのサマリー
修飾子と型メソッド説明default <T> TypedEntityLinks.ExtendedTypedEntityLinks<T>
forType
(ClassSE<T> type, FunctionSE<T, ObjectSE> extractor) 指定された型と識別子の抽出関数を使用してTypedEntityLinks
インスタンスを作成します。default <T> TypedEntityLinks<T>
forType
(FunctionSE<T, ?> extractor) 指定された識別子抽出関数を使用してTypedEntityLinks
インスタンスを作成します。指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返し、指定されたパラメーターをバッキングコントローラーがマップされている URI テンプレートに展開します。linkForItemResource
(ClassSE<?> type, ObjectSE id) 指定されたエンティティ型と ID を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。default <T> LinkBuilder
linkForItemResource
(T entity, FunctionSE<T, ObjectSE> identifierExtractor) 指定されたエンティティ型と識別子エクストラクターを管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。linkToCollectionResource
(ClassSE<?> type) 指定された型のコレクションリソースを指すLink
を作成します。linkToItemResource
(ClassSE<?> type, ObjectSE id) 指定されたエンティティ型と ID をサポートするアイテムリソースを指すLink
を作成します。default <T> Link
linkToItemResource
(T entity, FunctionSE<T, ObjectSE> identifierExtractor) 指定されたエンティティと識別子エクストラクターをサポートするアイテムリソースを指すLink
を作成します。インターフェース org.springframework.plugin.core.Plugin から継承されたメソッド
supports
メソッドの詳細
linkFor
指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。コントローラーが完全に展開された URI テンプレートにマップされていることを期待します (つまり、パス変数が使用されていません)。- パラメーター:
type
- 指すエンティティ型。null であってはなりません。- 戻り値:
- コレクションリソースを指す
LinkBuilder
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkFor
指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返し、指定されたパラメーターをバッキングコントローラーがマップされている URI テンプレートに展開します。- パラメーター:
type
- 指すエンティティ型。null であってはなりません。- 戻り値:
- コレクションリソースを指す
LinkBuilder
。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkForItemResource
指定されたエンティティ型と ID を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。実装は、アイテムリソース URI を公開するために使用されている URI 構造を認識します。- パラメーター:
type
- 指すエンティティ型。null であってはなりません。id
- 渡された型のオブジェクトの ID。null であってはなりません。- 戻り値:
- 指定された型と ID で識別される項目リソースを指す
LinkBuilder
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkForItemResource
指定されたエンティティ型と識別子エクストラクターを管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。実装は、アイテムリソース URI を公開するために使用される URI 構造を認識します。- パラメーター:
entity
- 指すエンティティ。null であってはなりません。identifierExtractor
- 指定されたエンティティの ID を決定する抽出関数は、null であってはなりません。- 戻り値:
- 指定されたエンティティによって識別されるアイテムリソースを指す
LinkBuilder
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkToCollectionResource
指定された型のコレクションリソースを指すLink
を作成します。リンクの関係型は実装クラスによって決定され、デフォルトでIanaLinkRelations.SELF
に設定する必要があります。- パラメーター:
type
- 指すエンティティ型。null であってはなりません。- 戻り値:
- 特定のエンティティ用に公開されたコレクションリソースを指す
Link
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkToItemResource
指定されたエンティティ型と ID をサポートするアイテムリソースを指すLink
を作成します。リンクの関係型は実装クラスによって決定され、デフォルトでIanaLinkRelations.SELF
に設定する必要があります。- パラメーター:
type
- 指すエンティティ型。null であってはなりません。id
- 指定された型のエンティティの識別子- 戻り値:
- 指定された型と ID を持つエンティティ用に公開されたリソースを指す
Link
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
linkToItemResource
指定されたエンティティおよび識別子エクストラクターをサポートする項目リソースを指すLink
を作成します。リンクの関係型は実装クラスによって決定され、デフォルトでIanaLinkRelations.SELF
に設定される必要があります。- パラメーター:
entity
- 指すエンティティ。null であってはなりません。identifierExtractor
- 指定されたエンティティの ID を決定する抽出関数。- 戻り値:
- 特定のエンティティ用に公開されたリソースを指す
Link
。null になることはありません。 - 例外:
IllegalArgumentExceptionSE
- 指定された型が不明な場合、エンティティはインフラストラクチャをリンクします。
forType
指定された識別子抽出関数を使用してTypedEntityLinks
インスタンスを作成します。- 型パラメーター:
T
- 処理されるエンティティの型。- パラメーター:
extractor
- 指定されたエンティティから識別子を導出するために使用するエクストラクター。- 戻り値:
forType
default <T> TypedEntityLinks.ExtendedTypedEntityLinks<T> forType(ClassSE<T> type, FunctionSE<T, ObjectSE> extractor) 指定された型と識別子の抽出関数を使用してTypedEntityLinks
インスタンスを作成します。- 型パラメーター:
T
- 処理されるエンティティの型。- パラメーター:
type
- エンティティの型。extractor
- 指定されたエンティティから識別子を導出するために使用するエクストラクター。- 戻り値: