パッケージ org.springframework.hateoas.mediatype.hal

クラス DefaultCurieProvider

java.lang.ObjectSE
org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
実装されたすべてのインターフェース:
CurieProvider
public class DefaultCurieProvider extends ObjectSE implements CurieProvider
単一の設定可能な UriTemplate ベースのキュリーをレンダリングする CurieProvider のデフォルトの実装。
導入:
0.9
作成者:
Oliver Gierke, Jeff Stano, Greg Turnquist

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

    • DefaultCurieProvider

      public DefaultCurieProvider(StringSE name, UriTemplate uriTemplate)
      指定された名前と UriTemplate の新しい DefaultCurieProvider を作成します。キュリーは、以前は接頭辞が付けられていなかった IANA 以外のリンク関係を拡張するために使用されます。
      パラメーター:
      name - null または空であってはなりません。
      uriTemplate - null であってはならず、テンプレート変数を 1 つだけ含んでいる必要があります。

    • DefaultCurieProvider

      public DefaultCurieProvider(MapSE<StringSE,UriTemplate> curies)
      指定されたキュリーの新しい DefaultCurieProvider を作成します。複数のキュリーが指定された場合、デフォルトのキュリーは登録されません。DefaultCurieProvider(Map, String) を使用して、提供されたキュリーのどれをデフォルトとして使用するかを定義します。
      パラメーター:
      curies - null であってはなりません。
      導入:
      0.19
      関連事項:

    • DefaultCurieProvider

      public DefaultCurieProvider(MapSE<StringSE,UriTemplate> curies, @Nullable StringSE defaultCurieName)
      指定された名前のキュリーをデフォルトとして使用して、指定されたキュリーの新しい DefaultCurieProvider を作成します。これは、プレフィックスのない非 IANA リンク関係を展開することを意味します。
      パラメーター:
      curies - null であってはなりません。
      defaultCurieName - null でもかまいません。
      導入:
      0.19

  • メソッドの詳細

    • getCurieInformation

      public CollectionSE<?> getCurieInformation(Links links)
      インターフェースからコピーされた説明: CurieProvider
      ベースキュリー情報としてレンダリングするオブジェクトを返します。実装は、返されたインスタンスが仕様で定義されているとおりにレンダリングされることを確認する必要があります。
      次で指定:
      インターフェース CurieProvider の getCurieInformation 
      パラメーター:
      links - これまでにレスポンスに追加された Links。
      戻り値:
      null であってはなりません。

    • getNamespacedRelFrom

      public HalLinkRelation getNamespacedRelFrom(Link link)
      インターフェースからコピーされた説明: CurieProvider
      指定された Link に対してレンダリングされる rel を返します。rel にプレフィックスを付ける可能性がありますが、実際の rel によっては付けないこともできます。
      次で指定:
      インターフェース CurieProvider の getNamespacedRelFrom 
      戻り値:

    • getNamespacedRelFor

      public HalLinkRelation getNamespacedRelFor(LinkRelation relation)
      インターフェースからコピーされた説明: CurieProvider
      指定された rel に対してレンダリングされる rel を返します。rel にプレフィックスを付ける可能性がありますが、実際の rel によっては付けないこともできます。
      次で指定:
      インターフェース CurieProvider の getNamespacedRelFor 
      戻り値:

    • getCurieHref

      protected StringSE getCurieHref(StringSE name, UriTemplate template)
      作成する DefaultCurieProvider.Curie インスタンスの href を返します。そもそもテンプレートが絶対的なものでない場合に備えて、現在のアプリケーション URI (サーブレットマッピング) を付加します。
      パラメーター:
      name - null または空になることはありません。
      template - null になることはありません。
      戻り値:
      作成される DefaultCurieProvider.Curie で href として使用される StringSE は null であってはなりません。