クラスの使用
org.springframework.hateoas.Link
Link を使用するパッケージ
パッケージ
説明
REST Web サービスの
Link およびリンク駆動表現の作成を容易にする値オブジェクト。 クライアント側のサポート。
一般的なメディア型のサポート。
Collection+JSON 表現を構築するための値オブジェクト。
HAL 固有の拡張機能、SPI、Jackson のカスタマイズ。
HAL-FORMS 拡張メディア型。
UBER メディア型 オブジェクト。
ハイパーメディア処理用のサーバー側コンポーネント。
コア API インターフェースの実装。
Link を構築し、RepresentationModel 型をアセンブルするための Spring MVC ヘルパークラス。Spring WebFlux コンポーネントを使用して
Link を構築し、RepresentationModel 型を組み立てます。org.springframework.hateoas 内の Link 使用
Link を返す org.springframework.hateoas のメソッド修飾子と型メソッド説明Link.andAffordance(Affordance affordance) 追加のAffordanceで新しいLinkを作成します。Link.andAffordances(ListSE<Affordance> affordances) 追加のAffordanceで新しいLinkを作成します。指定されたパラメーターを使用して展開することにより、現在のテンプレートをLinkに変換します。指定されたパラメーターを使用して展開することにより、現在のテンプレートをLinkに変換します。AffordanceModel.getLink()Links.getRequiredLink(StringSE rel) 指定された関係を持つLinkを返します。Links.getRequiredLink(LinkRelation relation) 指定された関係を持つLinkを返します。RepresentationModel.getRequiredLink(StringSE relation) 指定された関係を持つリンクを返します。RepresentationModel.getRequiredLink(LinkRelation relation) 指定された関係を持つリンクを返します。static Link自己関係を使用して、指定された URI への新しいリンクを作成します。static Link指定された関係で、指定された href に新しいLinkを作成します。static LinkLink.of(StringSE href, LinkRelation relation) 指定された href およびLinkRelationに新しいLinkを作成します。static LinkLink.of(UriTemplate template, StringSE relation) 指定されたUriTemplateおよびリンク関係に対して新しいLinkを作成します。static LinkLink.of(UriTemplate template, LinkRelation relation) static LinkLink.withAffordances(ListSE<Affordance> affordances) 指定されたAffordanceを使用して新しいLinkを作成します。Link.withDeprecation(@Nullable StringSE deprecation) すべての属性をコピーし、新しい非推奨を適用して、新しいLinkを作成します。すべての属性をコピーし、新しい href を適用して、新しいLinkを作成します。Link.withHreflang(@Nullable StringSE hreflang) すべての属性をコピーし、新しい hreflang を適用して、新しいLinkを作成します。すべての属性をコピーし、新しいメディアを適用して、新しいLinkを作成します。すべての属性をコピーし、新しい名前を適用して、新しいLinkを作成します。Link.withoutAffordances()Affordanceのない新しいLinkを返します。Link.withProfile(@Nullable StringSE profile) すべての属性をコピーし、新しいプロファイルを適用して、新しいLinkを作成します。同じ href でLinkRelationを指定して新しいLinkを作成します。Link.withRel(LinkRelation relation) 同じ href でLinkRelationを指定して新しいLinkを作成します。Link.withSelfRel()同じ URI を指しているがself関係を持つLinkを返します。すべての属性をコピーし、新しいタイトルを適用して、新しいLinkを作成します。すべての属性をコピーし、新しい型を適用して、新しいLinkを作成します。型 Link の引数を持つ型を返す org.springframework.hateoas のメソッド修飾子と型メソッド説明static CollectorSE<Link,?, Links> Links.collector()Links.getLink(LinkRelation rel) 指定された rel を持つLinkを返します。指定された関係を持つリンクを返します。RepresentationModel.getLink(LinkRelation relation) 指定されたLinkRelationとのリンクを返します。指定された関係を持つすべてのLinkを返します。RepresentationModel.getLinks(LinkRelation relation) 指定された関係を持つすべてのLinkを返します。PagedModel.getNextLink()次のページへのリンクを返します (設定されている場合)。SlicedModel.getNextLink()次のスライス (設定されている場合) を指すLinkを返します。PagedModel.getPreviousLink()前のページを指すリンクを返します (設定されている場合)。SlicedModel.getPreviousLink()前のスライスを指すLinkを返します (設定されている場合)。Links.iterator()Links.stream()Links.toList()型 Link のパラメーターを持つ org.springframework.hateoas のメソッド修飾子と型メソッド説明指定されたリンクをリソースに追加します。指定されたすべてのLinkをリソースに追加します。final Links指定された条件が true の場合、指定されたリンクを追加します。booleanstatic <T> CollectionModel<T>指定されたリンクで新しい空のコレクションモデルを作成します。static <T> PagedModel<T>PagedModel.empty(@Nullable PagedModel.PageMetadata metadata, Link... links) 指定されたPagedModel.PageMetadataとリンクで空のPagedModelを作成します。static <T> PagedModel<T>指定されたリンクで空のPagedModelを作成します。static <T> SlicedModel<T>SlicedModel.empty(@Nullable SlicedModel.SliceMetadata metadata, Link... links) 指定されたSlicedModel.SliceMetadataとリンクで空のSlicedModelを作成します。static <T> SlicedModel<T>指定されたリンクで空のSlicedModelを作成します。booleanリンクが論理的に同じかどうか、つまりすべてのリンク特性を共有しているが、異なるアフォーダンスが付加されている可能性があるかどうかを返します。Links.merge(Links.MergeMode mode, Link... links) 現在のLinksを、指定されたLinks.MergeModeを適用して指定されたものとマージします。static <T> CollectionModel<T>CollectionModel.of(IterableSE<T> content, Link... links) 指定されたコンテンツとLinkを使用してCollectionModelインスタンスを作成します (オプション)。static <T> EntityModel<T>指定されたコンテンツとLinkで新しいEntityModelを作成します (オプション)。static Linksstatic <T> PagedModel<T>PagedModel.of(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, Link... links) static <T> SlicedModel<T>SlicedModel.of(CollectionSE<T> content, @Nullable SlicedModel.SliceMetadata metadata, Link... links) booleanAffordanceModel.pointsToTargetOf(Link link) Affordanceが指定されたLinkのターゲットを指しているかどうかを返します。型 Link の型引数を持つ org.springframework.hateoas のメソッドパラメーター修飾子と型メソッド説明RepresentationModel.add(IterableSE<Link> links) 指定されたすべてのLinkをリソースに追加します。RepresentationModel.addAllIf(boolean guard, SupplierSE<? extends IterableSE<Link>> links) ガードが true の場合、指定された Supplier によって生成されたすべてのLinkを追加します。RepresentationModel.addIf(boolean guard, SupplierSE<Link> link) ガードが真の場合、指定されたサプライヤーによって生成されたLinkを追加します。Links.and(IterableSE<Link> links) final Links指定された条件が true の場合、指定されたリンクを追加します。booleanLinks.contains(IterableSE<Link> links) booleanLinks.containsSameLinksAs(IterableSE<Link> links) static <T> CollectionModel<T>CollectionModel.empty(IterableSE<Link> links) 指定されたリンクで新しい空のコレクションモデルを作成します。static <T> PagedModel<T>PagedModel.empty(@Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) 指定されたPagedModel.PageMetadataとリンクで空のPagedModelを作成します。static <T> PagedModel<T>PagedModel.empty(IterableSE<Link> links) 指定されたリンクで空のPagedModelを作成します。static <T> SlicedModel<T>SlicedModel.empty(@Nullable SlicedModel.SliceMetadata metadata, IterableSE<Link> links) 指定されたSlicedModel.SliceMetadataとリンクで空のSlicedModelを作成します。static <T> SlicedModel<T>SlicedModel.empty(IterableSE<Link> links) 指定されたリンクで空のSlicedModelを作成します。RepresentationModel.mapLink(LinkRelation relation, FunctionSE<Link, Link> mapper) 指定されたLinkRelationのリンクを、各リンクに適用されたマッパーに置き換えます。RepresentationModel.mapLink(LinkRelation relation, FunctionSE<Link, Link> mapper) 指定されたLinkRelationのリンクを、各リンクに適用されたマッパーに置き換えます。RepresentationModel.mapLinkIf(boolean condition, LinkRelation relation, FunctionSE<Link, Link> mapper) 指定された条件が true の場合、指定されたLinkRelationのリンクを各リンクに適用されたマッパーに置き換えます。RepresentationModel.mapLinkIf(boolean condition, LinkRelation relation, FunctionSE<Link, Link> mapper) 指定された条件が true の場合、指定されたLinkRelationのリンクを各リンクに適用されたマッパーに置き換えます。Links.merge(IterableSE<Link> links) Links.merge(Links.MergeMode mode, IterableSE<Link> links) 現在のLinksを、指定されたLinks.MergeModeを適用して指定されたものとマージします。Links.merge(Links.MergeMode mode, StreamSE<Link> links) 現在のLinksを、指定されたLinks.MergeModeを適用して指定されたものとマージします。static <T> EntityModel<T>EntityModel.of(T content, IterableSE<Link> links) 指定されたコンテンツとLinkで新しいEntityModelを作成します。static LinksLinks.of(IterableSE<Link> links) static <T> PagedModel<T>PagedModel.of(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) static <T> RepresentationModel<?>RepresentationModel.of(@Nullable T object, IterableSE<Link> links) 指定されたコンテンツオブジェクトとリンクの新しいRepresentationModelを作成します。static <T> SlicedModel<T>SlicedModel.of(CollectionSE<T> content, @Nullable SlicedModel.SliceMetadata metadata, IterableSE<Link> links) 型 Link のパラメーターを持つ org.springframework.hateoas のコンストラクター修飾子コンストラクター説明AffordanceModel(StringSE name, Link link, org.springframework.http.HttpMethod httpMethod, AffordanceModel.InputPayloadMetadata input, ListSE<QueryParameter> queryMethodParameters, AffordanceModel.PayloadMetadata output) RepresentationModel(Link initialLink) Link 型の型引数を持つ org.springframework.hateoas のコンストラクターパラメーター修飾子コンストラクター説明protectedEntityModel(T content, IterableSE<Link> links) 指定されたコンテンツとLinkで新しいEntityModelを作成します。protectedPagedModel(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links) protectedPagedModel(CollectionSE<T> content, @Nullable PagedModel.PageMetadata metadata, IterableSE<Link> links, @Nullable org.springframework.core.ResolvableType fallbackType) RepresentationModel(IterableSE<Link> initialLinks) protectedSlicedModel(CollectionSE<T> content, @Nullable SlicedModel.SliceMetadata metadata, IterableSE<Link> links) protectedSlicedModel(CollectionSE<T> content, @Nullable SlicedModel.SliceMetadata metadata, IterableSE<Link> links, @Nullable org.springframework.core.ResolvableType fallbackType) org.springframework.hateoas.client 内の Link 使用
Link を返す org.springframework.hateoas.client のメソッド修飾子と型メソッド説明Traverson.TraversalBuilder.asLink()後に続くように構成された rel の最後の rel で見つかったLinkを返します。Traverson.TraversalBuilder.asTemplatedLink()後に続くように構成された rel 内の最後の関係で見つかった、テンプレート化されたLinkを返します。protected LinkJsonPathLinkDiscoverer.extractLink(ObjectSE element, LinkRelation rel) 関連する属性を抽出してLinkを生成するための各LinkDiscovererのコールバック。default LinkLinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, InputStreamSE representation) 指定されたInputStreamSE 表現で、指定された関係型を持つ単一のリンクを検索します。default LinkLinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, StringSE representation) 指定されたStringSE 表現で指定された関係を持つ単一のリンクを検索します。型 Link の引数を持つ型を返す org.springframework.hateoas.client のメソッド修飾子と型メソッド説明JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStreamSE representation) JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, StringSE representation) default OptionalSE<Link>LinkDiscoverer.findLinkWithRel(StringSE relation, InputStreamSE representation) 指定されたInputStreamSE 表現で、指定された関係型を持つ単一のリンクを検索します。default OptionalSE<Link>LinkDiscoverer.findLinkWithRel(StringSE relation, StringSE representation) 指定されたStringSE 表現で、指定された関係型を持つ単一のリンクを検索します。LinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStreamSE representation) 指定されたInputStreamSE 表現で指定されたLinkRelationを持つ単一のリンクを検索します。LinkDiscoverer.findLinkWithRel(LinkRelation relation, StringSE representation) 指定されたStringSE 表現で指定されたLinkRelationを持つ単一のリンクを検索します。org.springframework.hateoas.mediatype 内の Link 使用
Link を返す org.springframework.hateoas.mediatype のメソッド修飾子と型メソッド説明ConfiguredAffordance.getTarget()アフォーダンスのターゲットを返します。AffordanceOperations.toLink()現在製作中のAffordanceを搭載したLinkを返します。Affordances.toLink()型 Link のパラメーターを持つ org.springframework.hateoas.mediatype のメソッド修飾子と型メソッド説明static AffordancesConfigurableAffordance.withTarget(Link target) すべての属性をコピーしてターゲットを置き換えることにより、新しいConfigurableAffordanceを作成します。org.springframework.hateoas.mediatype.collectionjson 内の Link 使用
型 Link の引数を持つ型を返す org.springframework.hateoas.mediatype.collectionjson のメソッド修飾子と型メソッド説明CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStreamSE representation) CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation, StringSE representation) org.springframework.hateoas.mediatype.hal 内の Link 使用
修飾子と型クラス説明protected static classJSON でレンダリングされたキュリーLinkを取得するための値オブジェクト。classHAL の rel 属性がレンダリングされないようにするためのカスタムミックスイン。修飾子と型メソッド説明protected LinkHalLinkDiscoverer.extractLink(ObjectSE element, LinkRelation rel) static Link型 Link の引数を持つ型を返す org.springframework.hateoas.mediatype.hal のメソッド修飾子と型メソッド説明HalJacksonModule.HalLinkListDeserializer.deserialize(tools.jackson.core.JsonParser jp, tools.jackson.databind.DeserializationContext ctxt) 型 Link のパラメーターを持つ org.springframework.hateoas.mediatype.hal のメソッド修飾子と型メソッド説明指定されたLinkのプレビューのセットアップを終了します。CurieProvider.getNamespacedRelFrom(Link link) 指定されたLinkに対してレンダリングされる rel を返します。DefaultCurieProvider.getNamespacedRelFrom(Link link) 全体にLinkを追加。型 Link の型引数を持つ org.springframework.hateoas.mediatype.hal のメソッドパラメーター修飾子と型メソッド説明HalModelBuilder.links(IterableSE<Link> links) 指定されたLinkをビルドするRepresentationModelに追加します。org.springframework.hateoas.mediatype.hal.forms 内の Link 使用
型 Link のパラメーターを持つ org.springframework.hateoas.mediatype.hal.forms のメソッド修飾子と型メソッド説明static HalFormsOptions.Remote指定されたLinkを使用して、新しいHalFormsOptions.Remoteオプション表現を作成します。org.springframework.hateoas.mediatype.uber 内の Link 使用
型 Link の引数を持つ型を返す org.springframework.hateoas.mediatype.uber のメソッド修飾子と型メソッド説明UberLinkDiscoverer.findLinkWithRel(LinkRelation rel, InputStreamSE representation) UberLinkDiscoverer.findLinkWithRel(LinkRelation rel, StringSE representation) org.springframework.hateoas.server 内の Link 使用
Link を返す org.springframework.hateoas.server のメソッド修飾子と型メソッド説明EntityLinks.linkToCollectionResource(ClassSE<?> type) 指定された型のコレクションリソースを指すLinkを作成します。TypedEntityLinks.ExtendedTypedEntityLinks.linkToCollectionResource()構成された型のコレクションリソースを指すLinkを作成します。EntityLinks.linkToItemResource(ClassSE<?> type, ObjectSE id) 指定されたエンティティ型と ID をサポートするアイテムリソースを指すLinkを作成します。default <T> LinkEntityLinks.linkToItemResource(T entity, FunctionSE<T, ObjectSE> identifierExtractor) 指定されたエンティティと識別子エクストラクターをサポートするアイテムリソースを指すLinkを作成します。TypedEntityLinks.linkToItemResource(T entity) 指定されたエンティティをサポートするアイテムリソースを指すLinkを作成します。default Link指定されたリンク関係を使用して、現在のビルダーインスタンスによってビルドされたLinkを作成します。LinkBuilder.withRel(LinkRelation rel) 指定されたLinkRelationを使用して、現在のビルダーインスタンスによってビルドされたLinkを作成します。LinkBuilder.withSelfRel()デフォルトの自己リンク関係を使用して、現在のビルダーインスタンスによってビルドされたLinkを作成します。org.springframework.hateoas.server.core 内の Link 使用
Link を返す org.springframework.hateoas.server.core のメソッド修飾子と型メソッド説明ControllerEntityLinks.linkToCollectionResource(ClassSE<?> entity) DelegatingEntityLinks.linkToCollectionResource(ClassSE<?> type) ControllerEntityLinks.linkToItemResource(ClassSE<?> entity, ObjectSE id) DelegatingEntityLinks.linkToItemResource(ClassSE<?> type, ObjectSE id) LinkBuilderSupport.withRel(LinkRelation rel) LinkBuilderSupport.withSelfRel()org.springframework.hateoas.server.mvc 内の Link 使用
Link を返す org.springframework.hateoas.server.mvc のメソッド修飾子と型メソッド説明static Linkstatic LinkMvcLink.of(ObjectSE invocation, LinkRelation relation) 指定されたMvcUriComponentsBuilder呼び出しから新しいLinkを作成します。static LinkMvcLink.of(SupplierSE<ObjectSE> invocation) static LinkMvcLink.of(SupplierSE<ObjectSE> invocation, LinkRelation relation) 指定された遅延MvcUriComponentsBuilder呼び出しから新しいLinkを作成します。org.springframework.hateoas.server.reactive 内の Link 使用
型 Link の引数を持つ型を返す org.springframework.hateoas.server.reactive のメソッド修飾子と型メソッド説明reactor.core.publisher.Mono<Link>WebFluxLinkBuilder.WebFluxLink.toMono()リアクティブパイプライン内でさらに処理するために、Linkの基になるMonoを返します。reactor.core.publisher.Mono<Link>WebFluxLinkBuilder.WebFluxLink.toMono(FunctionSE<Link, Link> finisher) 型 Link の型引数を持つ org.springframework.hateoas.server.reactive のメソッドパラメーター修飾子と型メソッド説明WebFluxLinkBuilder.WebFluxLink.map(FunctionSE<Link, Link> mapper) 指定されたマッパーを使用して変換された現在のLinkインスタンスで新しいWebFluxLinkBuilder.WebFluxLinkを作成します。WebFluxLinkBuilder.WebFluxLink.map(FunctionSE<Link, Link> mapper) 指定されたマッパーを使用して変換された現在のLinkインスタンスで新しいWebFluxLinkBuilder.WebFluxLinkを作成します。WebFluxLinkBuilder.WebFluxBuilder.toLink(FunctionSE<WebFluxLinkBuilder, reactor.core.publisher.Mono<Link>> finisher) 指定されたWebFluxLinkBuilderからLinkを生成するための一般的なコールバック。reactor.core.publisher.Mono<Link>WebFluxLinkBuilder.WebFluxLink.toMono(FunctionSE<Link, Link> finisher) reactor.core.publisher.Mono<Link>WebFluxLinkBuilder.WebFluxLink.toMono(FunctionSE<Link, Link> finisher) Link 型の型引数を持つ org.springframework.hateoas.server.reactive のコンストラクターパラメーター