パッケージ org.springframework.hateoas.server.mvc

クラス WebMvcLinkBuilder

java.lang.ObjectSE
org.springframework.hateoas.server.core.LinkBuilderSupport<T>
org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport<WebMvcLinkBuilder>
org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
実装されたすべてのインターフェース:
LinkBuilder
public class WebMvcLinkBuilder extends TemplateVariableAwareLinkBuilderSupport<WebMvcLinkBuilder>
Spring MVC コントローラーを指す Link インスタンスの構築を容易にするビルダー。
作成者:
Oliver Gierke, Kamill Sokol, Greg Turnquist, Kevin Conaway, Andrew Naydyonock, Oliver Trosien, Greg Turnquist, Lars Michele

  • メソッドの詳細

    • linkTo

      public static WebMvcLinkBuilder linkTo(ClassSE<?> controller)
      指定されたコントローラークラスにアノテーションが付けられたマッピングのベースを使用して、新しい WebMvcLinkBuilder を作成します。
      パラメーター:
      controller - アノテーションを検出するクラス。null であってはなりません。
      戻り値:

    • linkTo

      public static WebMvcLinkBuilder linkTo(ClassSE<?> controller, ObjectSE... parameters)
      指定されたコントローラークラスにアノテーションが付けられたマッピングのベースを使用して、新しい WebMvcLinkBuilder を作成します。追加のパラメーターは、クラススコープリクエストマッピングで潜在的に利用可能なパス変数を埋めるために使用されます。
      パラメーター:
      controller - アノテーションを検出するクラス。null であってはなりません。
      parameters - アノテーションで宣言された URI テンプレートにバインドする追加のパラメーターは、null であってはなりません。
      戻り値:

    • linkTo

      public static WebMvcLinkBuilder linkTo(ClassSE<?> controller, MapSE<StringSE,?> parameters)
      指定されたコントローラークラスにアノテーションが付けられたマッピングのベースを使用して、新しい WebMvcLinkBuilder を作成します。パラメーターマップは、クラススコープのリクエストマッピングで潜在的に利用可能なパス変数を埋めるために使用されます。
      パラメーター:
      controller - アノテーションを検出するクラス。null であってはなりません。
      parameters - アノテーションで宣言された URI テンプレートにバインドする追加のパラメーターは、null であってはなりません。
      戻り値:

    • linkTo

      public static WebMvcLinkBuilder linkTo(MethodSE method)

    • linkTo

      public static WebMvcLinkBuilder linkTo(MethodSE method, ObjectSE... parameters)

    • linkTo

      public static WebMvcLinkBuilder linkTo(ClassSE<?> controller, MethodSE method)

    • linkTo

      public static WebMvcLinkBuilder linkTo(ClassSE<?> controller, MethodSE method, ObjectSE... parameters)

    • linkTo

      public static WebMvcLinkBuilder linkTo(ObjectSE invocationValue)
      コントローラーメソッドを指す WebMvcLinkBuilder を作成します。methodOn(Class, Object...) または DummyInvocationUtils.methodOn(Class, Object...) を介して作成できるダミーのメソッド呼び出し結果を渡します。
       @RequestMapping("/customers")
 class CustomerController {

   @RequestMapping("/{id}/addresses")
   HttpEntity<Addresses> showAddresses(@PathVariable Long id) { … }
 }

 Link link = linkTo(methodOn(CustomerController.class).showAddresses(2L)).withRel("addresses");
      結果の Link インスタンスは /customers/2/addresses を指し、addresses の rel を持ちます。メソッド呼び出しの制約の詳細については、DummyInvocationUtils.methodOn(Class, Object...) を参照してください。
      パラメーター:
      invocationValue -
      戻り値:

    • afford

      public static Affordance afford(ObjectSE invocationValue)
      WebMvcLinkBuilder から Link を抽出し、関連する Affordance を検索します。1 つだけにする必要があります。
       Link findOneLink = linkTo(methodOn(EmployeeController.class).findOne(id)).withSelfRel()
                .andAffordance(afford(methodOn(EmployeeController.class).updateEmployee(null, id)));
      これはリンクを取得し、別の Spring MVC ハンドラーメソッドに基づいて Affordance を追加します。
      パラメーター:
      invocationValue -
      戻り値:

    • methodOn

      public static <T> T methodOn(ClassSE<T> controller, ObjectSE... parameters)
      WebMvcLinkBuilder の静的インポートを使用する場合に使用できる DummyInvocationUtils.methodOn(Class, Object...) のラッパー。
      パラメーター:
      controller - null であってはなりません。
      parameters - パラメーターを使用して、型レベルマッピングでテンプレート変数を継承します。
      戻り値:

    • getThis

      protected WebMvcLinkBuilder getThis()
      クラスからコピーされた説明: LinkBuilderSupport
      現在の具体的なインスタンスを返します。
      次で指定:
      クラス LinkBuilderSupport<WebMvcLinkBuilder> の getThis 
      戻り値:

    • createNewInstance

      protected WebMvcLinkBuilder createNewInstance(UriComponents components, ListSE<Affordance> affordances, TemplateVariables variables)
      次で指定:
      クラス TemplateVariableAwareLinkBuilderSupport<WebMvcLinkBuilder> の createNewInstance 

    • toUriComponentsBuilder

      public UriComponentsBuilder toUriComponentsBuilder()
      UriComponentsBuilder を返し、すでに構築された URI をよりきめ細かい方法で構築し続けます。
      戻り値: