パッケージ hajimeapi4j.internal.request

クラス RestActionImpl<T>

java.lang.Object
hajimeapi4j.internal.request.RestActionImpl<T>
すべての実装されたインタフェース:
RestAction<T>
public class RestActionImpl<T> extends Object implements RestAction<T>

  • フィールド詳細

  • コンストラクタの詳細

  • メソッドの詳細

    • complete

      @NonNull public T complete()
      インタフェースからコピーされた説明: RestAction
      REST APIへのリクエストを実行されたスレッドをロックして実行します。

      これはつまり、APIへのリクエストから情報パースまでを、呼び出されたスレッド内で完結させます。

      取得した情報をすぐに使用する場合、リクエストの並列性を考慮しない場合はこのメソッドをご使用ください。

      非同期的に情報を処理する場合は submit メソッドをご使用ください。

      定義:
      complete インタフェース内 RestAction<T>
      戻り値:
      APIから取得した情報をラップしたデータ

    • submit

      public CompletableFuture<T> submit()
      インタフェースからコピーされた説明: RestAction
      REST APIへのリクエストを、ライブラリ内で独自に作成したリクエストスレッドにて行います。

      作成されるスレッドは Executors.newCachedThreadPool(ThreadFactory) にて、独自の ThreadFactory 実装を用いたスレッドプールにより生成されます。

      情報を非同期的に取得し、その後のコールバックを遅延して処理させる場合はこのメソッドをご使用ください。

      同期的にデータを取得する場合は complete メソッドをご使用ください。

      定義:
      submit インタフェース内 RestAction<T>
      戻り値:
      APIから取得した情報をラップしたデータを内包する CompletableFuture

    • constructRoute

      public CompiledRoute constructRoute(Map<String,String> params)
      インタフェースからコピーされた説明: RestAction
      リクエストに必要なパラメータ情報をセットするメソッドです。

      通常は内部で自動的にパラメータ情報をセットするため、使用する必要はありません。

      定義:
      constructRoute インタフェース内 RestAction<T>
      パラメータ:
      params - 現在のActionにセットするパラメータ情報
      戻り値:
      パラメータ情報をセットしたAPIへのURI情報