パッケージ org.springframework.data.web

クラス PagedResourcesAssembler<T>

java.lang.ObjectSE
org.springframework.data.web.PagedResourcesAssembler<T>
実装されているすべてのインターフェース:
RepresentationModelAssembler<Page<T>,PagedModel<EntityModel<T>>>
public class PagedResourcesAssembler<T> extends ObjectSE implements RepresentationModelAssembler<Page<T>,PagedModel<EntityModel<T>>>
RepresentationModelAssembler を使用すると、Page インスタンスを簡単に PagedModel に変換できます。
導入:
1.6
作成者:
Oliver Gierke, Nick Williams, Marcel Overdijk

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

  • メソッドの詳細

    • setForceFirstAndLastRels

      public void setForceFirstAndLastRels(boolean forceFirstAndLastRels)
      作成された PagedModel に first および last リンクを常に追加するかどうかを構成します。デフォルトは false で、first および last リンクは prev および next リンクと組み合わせてのみ表示されます。
      パラメーター:
      forceFirstAndLastRels - 作成された PagedModel に first および last リンクを常に追加するかどうか。
      導入:
      1.11

    • withParameter

      public PagedResourcesAssembler<T> withParameter(@Nullable MethodParameter parameter)
      指定された参照 MethodParameter を使用して新しい PagedResourcesAssembler を作成します。
      パラメーター:
      parameter - null でもかまいません。
      戻り値:
      null になることはありません。
      導入:
      3.1

    • toModel

      public PagedModel<EntityModel<T>> toModel(Page<T> entity)
      次で指定:
      インターフェース RepresentationModelAssembler<Page<T>,PagedModel<EntityModel<T>>> の toModel 

    • toModel

      public PagedModel<EntityModel<T>> toModel(Page<T> page, Link selfLink)
      指定された Page を PagedModel.PageMetadata インスタンスに変換し、含まれる要素を PagedModel インスタンスにラップして、新しい PagedModel を作成します。指定された self リンクに基づいてページネーションリンクを追加します。
      パラメーター:
      page - null であってはなりません。
      selfLink - null であってはなりません。
      戻り値:

    • toModel

      public <R extends RepresentationModel<?>> PagedModel<R> toModel(Page<T> page, RepresentationModelAssembler<T,R> assembler)
      指定された Page を PagedModel.PageMetadata インスタンスに変換し、指定された PagedModel を使用して Page の要素をリソースに変換することにより、新しい PagedModel を作成します。
      パラメーター:
      page - null であってはなりません。
      assembler - null であってはなりません。
      戻り値:

    • toModel

      public <R extends RepresentationModel<?>> PagedModel<R> toModel(Page<T> page, RepresentationModelAssembler<T,R> assembler, Link link)
      指定された Page を PagedModel.PageMetadata インスタンスに変換し、指定された PagedModel を使用して Page の要素をリソースに変換することにより、新しい PagedModel を作成します。指定された self リンクに基づいてページネーションリンクを追加します。
      パラメーター:
      page - null であってはなりません。
      assembler - null であってはなりません。
      link - null であってはなりません。
      戻り値:

    • toEmptyModel

      public PagedModel<?> toEmptyModel(Page<?> page, ClassSE<?> type)
      指定されたドメイン型に対して、空のコレクション EmbeddedWrapper を持つ PagedModel を作成します。
      パラメーター:
      page - null であってはならず、コンテンツは空でなければなりません。
      type - null であってはなりません。
      戻り値:
      導入:
      2.0

    • toEmptyModel

      public PagedModel<?> toEmptyModel(Page<?> page, ClassSE<?> type, Link link)
      指定されたドメイン型に対して、空のコレクション EmbeddedWrapper を持つ PagedModel を作成します。
      パラメーター:
      page - null であってはならず、コンテンツは空でなければなりません。
      type - null であってはなりません。
      link - null であってはなりません。
      戻り値:
      導入:
      1.11

    • createPagedModel

      protected <R extends RepresentationModel<?>, S> PagedModel<R> createPagedModel(ListSE<R> resources, PagedModel.PageMetadata metadata, Page<S> page)
      下流にページネーションリンクを装備する PagedModel を作成します。
      パラメーター:
      resources - 元のページの要素が RepresentationModel インスタンスにマップされます。
      metadata - 計算された PagedModel.PageMetadata は null であってはなりません。
      page - アセンブラーに渡される元のページは null であってはなりません。
      戻り値:
      null であってはなりません。

    • getMethodParameter

      @Nullable @DeprecatedSE(since="3.1", forRemoval=true) protected MethodParameter getMethodParameter()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      3.1 以降は、むしろ withParameter(MethodParameter) を使用してインスタンスをセットアップします。
      ページングおよびソートリクエストパラメーターを潜在的に修飾するために使用される MethodParameter を返します。デフォルトの実装は null を返します。これは、パラメーターが修飾されないことを意味します。
      戻り値:
      導入:
      1.7