パッケージ hajimeapi4j.api.endpoint

インタフェース EndPoint

すべてのスーパーインタフェース:
RestAction<EndPoint>
既知のサブインタフェースのリスト:
ListEndPoint, MusicEndPoint, TaxEndPoint
既知の実装クラスのリスト:
Disc, EndPointImpl, ListEndPointImpl, Live, Member, MemberSolo, MusicEndPointImpl, Song, TaxEndPointImpl, Unit
public interface EndPoint extends RestAction<EndPoint>
ふじわらはじめAPIにて提供されるエンドポイントの共通仕様を定義します。

基本的にAPI側で規定されている共通仕様に則っていますが、一部Javaの仕様を優先させているため、APIと対応するラッパークラスの挙動が異なる場合があります。

アノテーション「Nonnull」で修飾されているGetterはそのエンドポイントにおいて必ず値が存在することを表します。

また、OptionalでラップされているGetterの扱いについてはエンドポイント、レスポンスごとに変わりますのでご了承ください。

このクラスで実装されているGetterは全てのエンドポイント、データクラスで情報が格納されていることが保証されているため、全てのGetterにNonnullアノテーションを付加しています。
導入されたバージョン:
5.0.0.0-Alpha.1
関連項目:

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    boolean
    checkEmpty()
    このインスタンスに格納されている情報が空であるか確認します。
    static EndPoint
    createEmpty()
    空のインスタンスを作成します
    RestAction<EndPoint>
    fromApi()
    取得したJSON API情報を使用し、その情報の詳細を取得できるようにするためのユーティリティメソッドです。
    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」の情報を取得します。

    インタフェースから継承されたメソッド hajimeapi4j.api.request.RestAction

    complete, constructRoute, submit

  • メソッドの詳細

    • getName

      @Nonnull String getName()
      ふじわらはじめAPIで規定されている、主に「名称」「曲名」などに割り当てられているJSONキー「name」の情報を取得します。
      戻り値:
      JSONキー「name」に指定されている情報

    • getType

      @Nonnull String getType()
      ふじわらはじめAPIで規定されている、主に出力データタイプの規定に割り当てられているJSONキー「type」の情報を取得します。
      戻り値:
      JSONキー「type」に指定されている情報

    • createEmpty

      @CheckReturnValue static EndPoint createEmpty()
      空のインスタンスを作成します
      戻り値:
      空情報のインスタンス

    • getTaxId

      int getTaxId()
      ふじわらはじめAPIで規定されている、主にカテゴリID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「tax_id」の情報を取得します。

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

      戻り値:
      JSONキー「tax_id」に指定されている情報

    • getSongId

      int getSongId()
      ふじわらはじめAPIで規定されている、主に楽曲ID（ふじわらはじめAPI内部管理ID）に割り当てられているJSONキー「song_id」の情報を取得します。

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

      戻り値:
      JSONキー「song_id」に規定されている情報

    • getLink

      @Nonnull String getLink()
      ふじわらはじめAPIで規定されている、主にそのカテゴリページへのURLに割り当てられているJSONキー「link」の情報を取得します。
      戻り値:
      JSONキー「link」に規定されている情報

    • fromApi

      @Nonnull @CheckReturnValue RestAction<EndPoint> fromApi()
      取得したJSON API情報を使用し、その情報の詳細を取得できるようにするためのユーティリティメソッドです。
      戻り値:
      エンドポイントに応じた、API情報から生成したエンドポイント情報

    • getApi

      @Nonnull String getApi()
      ふじわらはじめAPIで規定されている、主にそのカテゴリの詳細情報を格納しているAPIへのURI情報に割り当てられているJSONキー「api」の情報を取得します。
      戻り値:
      JSONキー「api」に規定されている情報

    • checkEmpty

      boolean checkEmpty()
      このインスタンスに格納されている情報が空であるか確認します。

      空である判定は

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