型パラメータ:: T - リクエスト受信後に受け取るデータに対応したラッパークラス

既知のサブインタフェースのリスト:: EndPoint, ListEndPoint, MusicEndPoint, TaxEndPoint

既知の実装クラスのリスト:: Disc, EndPointImpl, ListEndPointImpl, Live, Member, MemberSolo, MusicEndPointImpl, RestActionImpl, Song, TaxEndPointImpl, Unit

public interface RestAction<T>

REST APIとの相互作用全般を引き受けるクラスです。

このクラスではリクエストの送信のみに特化しており、あとから情報を付け足したり省略したりといったことはできません。

関連項目:

メソッドの概要

修飾子とタイプ

メソッド

説明

T

complete()

REST APIへのリクエストを実行されたスレッドをロックして実行します。

CompiledRoute

constructRoute(Map<String,String> params)

リクエストに必要なパラメータ情報をセットするメソッドです。

CompletableFuture<T>

submit()

REST APIへのリクエストを、ライブラリ内で独自に作成したリクエストスレッドにて行います。

メソッドの詳細
- complete
  
  @Nonnull T complete()
  
  REST APIへのリクエストを実行されたスレッドをロックして実行します。
  これはつまり、APIへのリクエストから情報パースまでを、呼び出されたスレッド内で完結させます。
  取得した情報をすぐに使用する場合、リクエストの並列性を考慮しない場合はこのメソッドをご使用ください。
  非同期的に情報を処理する場合は submit メソッドをご使用ください。
  
  戻り値:
  
  APIから取得した情報をラップしたデータ
- submit
  
  CompletableFuture<T> submit()
  
  REST APIへのリクエストを、ライブラリ内で独自に作成したリクエストスレッドにて行います。
  作成されるスレッドは Executors.newCachedThreadPool(ThreadFactory) にて、独自の ThreadFactory 実装を用いたスレッドプールにより生成されます。
  情報を非同期的に取得し、その後のコールバックを遅延して処理させる場合はこのメソッドをご使用ください。
  同期的にデータを取得する場合は complete メソッドをご使用ください。
  
  戻り値:
  
  APIから取得した情報をラップしたデータを内包する CompletableFuture
- constructRoute
  
  @CheckReturnValue CompiledRoute constructRoute(Map<String,String> params)
  
  リクエストに必要なパラメータ情報をセットするメソッドです。
  通常は内部で自動的にパラメータ情報をセットするため、使用する必要はありません。
  
  パラメータ:
  
  params - 現在のActionにセットするパラメータ情報
  
  戻り値:
  
  パラメータ情報をセットしたAPIへのURI情報

インタフェース RestAction<T>

メソッドの概要

メソッドの詳細

complete

submit

constructRoute