パッケージ hajimeapi4j.internal.endpoint

クラス EndPointImpl

java.lang.Object
hajimeapi4j.internal.endpoint.EndPointImpl
すべての実装されたインタフェース:
EndPoint, RestAction<EndPoint>
直系の既知のサブクラス:
Disc, ListEndPointImpl, Live, Member, MusicEndPointImpl, Song, TaxEndPointImpl, Unit
public class EndPointImpl extends Object implements EndPoint
APIにおける、全てに共通しているパラメータ情報やリクエスト情報を定義します。

一部パラメータ情報は情報が他パラメータ情報と共通している場合があります。ご注意ください。

導入されたバージョン:
5.0.0.0-Alpha.1
関連項目:

  • フィールドの概要

    フィールド
    修飾子とタイプ
    フィールド
    説明
    protected String
    api
     
    protected String
    link
     
    protected String
    name
     
    protected int
    songId
     
    protected int
    taxId
     
    protected String
    type
     

  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    EndPointImpl()
     

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    boolean
    checkEmpty()
    このインスタンスに格納されている情報が空であるか確認します。
    EndPoint
    complete()
    REST APIへのリクエストを実行されたスレッドをロックして実行します。
    CompiledRoute
    constructRoute(Map<String,String> params)
    リクエストに必要なパラメータ情報をセットするメソッドです。
    static EndPoint
    createEmpty()
    空のEndPointインスタンスを返します。
    @NotNull RestAction<EndPoint>
    fromApi()
    取得したURI情報を基に、新しいリクエストを送信するためのインスタンスを作成します。
    String
    getApi()
    ふじわらはじめAPIで規定されている、主にそのカテゴリの詳細情報を格納しているAPIへのURI情報に割り当てられているJSONキー「api」の情報を取得します。
    String
    getLink()
    ふじわらはじめAPIで規定されている、主にそのカテゴリページへのURLに割り当てられているJSONキー「link」の情報を取得します。
    String
    getName()
    ふじわらはじめAPIで規定されている、主に「名称」「曲名」などに割り当てられているJSONキー「name」の情報を取得します。
    int
    getSongId()
    ふじわらはじめAPIで規定されている、主に楽曲ID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「song_id」の情報を取得します。
    int
    getTaxId()
    ふじわらはじめAPIで規定されている、主にカテゴリID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「tax_id」の情報を取得します。
    String
    getType()
    ふじわらはじめAPIで規定されている、主に出力データタイプの規定に割り当てられているJSONキー「type」の情報を取得します。
    CompletableFuture<EndPoint>
    submit()
    REST APIへのリクエストを、ライブラリ内で独自に作成したリクエストスレッドにて行います。

    クラスから継承されたメソッド java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • フィールド詳細

    • name

      protected String name

    • type

      protected String type

    • taxId

      protected int taxId

    • songId

      protected int songId

    • api

      protected String api

  • コンストラクタの詳細

    • EndPointImpl

      public EndPointImpl()

  • メソッドの詳細

    • getName

      @Nonnull public String getName()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主に「名称」「曲名」などに割り当てられているJSONキー「name」の情報を取得します。
      定義:
      getName インタフェース内 EndPoint
      戻り値:
      JSONキー「name」に指定されている情報

    • getType

      @Nonnull public String getType()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主に出力データタイプの規定に割り当てられているJSONキー「type」の情報を取得します。
      定義:
      getType インタフェース内 EndPoint
      戻り値:
      JSONキー「type」に指定されている情報

    • getTaxId

      public int getTaxId()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主にカテゴリID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「tax_id」の情報を取得します。

      この情報は EndPoint.getSongId()と排他的になっており、どちらか一方が必ず参照可能です。

      定義:
      getTaxId インタフェース内 EndPoint
      戻り値:
      JSONキー「tax_id」に指定されている情報

    • getSongId

      public int getSongId()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主に楽曲ID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「song_id」の情報を取得します。

      この情報は EndPoint.getTaxId() と排他的になっており、どちらか一方が必ず参照可能です。

      定義:
      getSongId インタフェース内 EndPoint
      戻り値:
      JSONキー「song_id」に規定されている情報

    • getLink

      @Nonnull public String getLink()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主にそのカテゴリページへのURLに割り当てられているJSONキー「link」の情報を取得します。
      定義:
      getLink インタフェース内 EndPoint
      戻り値:
      JSONキー「link」に規定されている情報

    • getApi

      @Nonnull public String getApi()
      インタフェースからコピーされた説明: EndPoint
      ふじわらはじめAPIで規定されている、主にそのカテゴリの詳細情報を格納しているAPIへのURI情報に割り当てられているJSONキー「api」の情報を取得します。
      定義:
      getApi インタフェース内 EndPoint
      戻り値:
      JSONキー「api」に規定されている情報

    • fromApi

      @NotNull @CheckReturnValue public @NotNull RestAction<EndPoint> fromApi()
      取得したURI情報を基に、新しいリクエストを送信するためのインスタンスを作成します。
      定義:
      fromApi インタフェース内 EndPoint
      戻り値:
      URI情報による新しいインスタンス

    • complete

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

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

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

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

      定義:
      complete インタフェース内 RestAction<EndPoint>
      戻り値:
      リクエスト送信用のメソッドです。使用できません。

    • submit

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

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

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

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

      定義:
      submit インタフェース内 RestAction<EndPoint>
      戻り値:
      リクエスト送信用のメソッドです。使用できません。

    • constructRoute

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

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

      定義:
      constructRoute インタフェース内 RestAction<EndPoint>
      パラメータ:
      params - パラメータ情報
      戻り値:
      リクエスト送信用のメソッドです。使用できません。

    • checkEmpty

      public boolean checkEmpty()
      インタフェースからコピーされた説明: EndPoint
      このインスタンスに格納されている情報が空であるか確認します。

      空である判定は

      以上の条件で判定を行います。
      定義:
      checkEmpty インタフェース内 EndPoint
      戻り値:
      インスタンスが空である場合は true, そうでない場合は false

    • createEmpty

      @CheckReturnValue public static EndPoint createEmpty()
      空のEndPointインスタンスを返します。
      戻り値:
      空のインスタンス