パッケージ org.springframework.hateoas

クラス RepresentationModel<T extends RepresentationModel<? extends T>>

java.lang.ObjectSE
org.springframework.hateoas.RepresentationModel<T>
既知の直属サブクラス
CollectionModel、EntityModel、RepresentationModelMixin
public class RepresentationModel<T extends RepresentationModel<? extends T>> extends ObjectSE
DTO がリンクを収集するための基本クラス。
作成者:
Oliver Gierke, Johhny Lim, Greg Turnquist

  • コンストラクターの詳細

    • RepresentationModel

      public RepresentationModel()

    • RepresentationModel

      public RepresentationModel(Link initialLink)

    • RepresentationModel

      public RepresentationModel(IterableSE<Link> initialLinks)

  • メソッドの詳細

    • of

      public static <T> RepresentationModel<?> of(@Nullable T object)
      指定されたコンテンツオブジェクトの新しい RepresentationModel を作成し、リンクは作成しません。
      パラメーター:
      object - null でもかまいません。
      戻り値:
      関連事項:

    • of

      public static <T> RepresentationModel<?> of(@Nullable T object, IterableSE<Link> links)
      指定されたコンテンツオブジェクトとリンクに対して新しい RepresentationModel を作成します。コンテンツが null の場合は単純な RepresentationModel を返し、指定されたコンテンツオブジェクトが CollectionSE の場合は CollectionModel を返し、それ以外の場合は EntityModel を返します。
      パラメーター:
      object - null でもかまいません。
      links - null であってはなりません。
      戻り値:

    • add

      public T add(Link link)
      指定されたリンクをリソースに追加します。
      パラメーター:
      link -

    • add

      public T add(IterableSE<Link> links)
      指定されたすべての Link をリソースに追加します。
      パラメーター:
      links - null であってはなりません。
      関連事項:

    • add

      public T add(Link... links)
      指定されたすべての Link をリソースに追加します。
      パラメーター:
      links - null であってはなりません。

    • addIf

      public T addIf(boolean guard, SupplierSE<Link> link)
      ガードが真の場合、指定されたサプライヤーによって生成された Link を追加します。
      パラメーター:
      guard - 指定された SupplierSE によって生成された Link を追加するかどうか。
      link - ガードが true の場合に追加する Link。
      戻り値:

    • addAllIf

      public T addAllIf(boolean guard, SupplierSE<? extends IterableSE<Link>> links)
      ガードが true の場合、指定された Supplier によって生成されたすべての Link を追加します。
      パラメーター:
      guard - 指定された SupplierSE によって生成された Link を追加するかどうか。
      links - ガードが true の場合に追加する Link。
      戻り値:
      関連事項:

    • hasLinks

      public boolean hasLinks()
      リソースに Link が含まれているかどうかを返します。
      戻り値:

    • hasLink

      public boolean hasLink(StringSE rel)
      リソースに指定された rel の Link が含まれているかどうかを返します。
      パラメーター:
      rel -
      戻り値:

    • hasLink

      public boolean hasLink(LinkRelation rel)

    • getLinks

      public Links getLinks()
      このリソースに含まれるすべての Link を返します。
      戻り値:

    • removeLinks

      public T removeLinks()
      これまでにリソースに追加されたすべての Link を削除します。

    • getLink

      public OptionalSE<Link> getLink(StringSE relation)
      指定された関係を持つリンクを返します。
      パラメーター:
      relation - null または空であってはなりません。
      戻り値:
      指定された関係を持つリンク、または見つからない場合は Optional.empty()。

    • getLink

      public OptionalSE<Link> getLink(LinkRelation relation)
      指定された LinkRelation とのリンクを返します。
      パラメーター:
      relation -
      戻り値:

    • getRequiredLink

      public Link getRequiredLink(StringSE relation)
      指定された関係を持つリンクを返します。
      パラメーター:
      relation - null または空であってはなりません。
      戻り値:
      指定されたリレーションを持つリンク。
      例外:
      IllegalArgumentExceptionSE - 指定された関係とのリンクが見つからない場合。

    • getRequiredLink

      public Link getRequiredLink(LinkRelation relation)
      指定された関係を持つリンクを返します。
      パラメーター:
      relation - null であってはなりません。
      戻り値:
      指定されたリレーションを持つリンク。
      例外:
      IllegalArgumentExceptionSE - 指定された関係とのリンクが見つからない場合。

    • getLinks

      public ListSE<Link> getLinks(StringSE relation)
      指定された関係を持つすべての Link を返します。
      パラメーター:
      relation - null であってはなりません。
      戻り値:
      ListSE のリンク

    • getLinks

      public ListSE<Link> getLinks(LinkRelation relation)
      指定された関係を持つすべての Link を返します。
      パラメーター:
      relation - null であってはなりません。
      戻り値:
      ListSE のリンク

    • mapLink

      public T mapLink(LinkRelation relation, FunctionSE<Link,Link> mapper)
      指定された LinkRelation のリンクを、各リンクに適用されたマッパーに置き換えます。
      パラメーター:
      relation - ソースリンクを選択するための LinkRelation は null であってはなりません。
      mapper - 現在のリンクに適用する FunctionSE は null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • mapLinkIf

      public T mapLinkIf(boolean condition, LinkRelation relation, FunctionSE<Link,Link> mapper)
      指定された条件が true の場合、指定された LinkRelation のリンクを各リンクに適用されたマッパーに置き換えます。
      パラメーター:
      condition - マッピングを適用するために真である必要がある条件。
      relation - ソースリンクを選択するための LinkRelation は null であってはなりません。
      mapper - 現在のリンクに適用する FunctionSE は null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • equals

      public boolean equals(@Nullable ObjectSE obj)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode