パッケージ hajimeapi4j.internal.builder

クラス TaxEndPointBuilder

java.lang.Object
hajimeapi4j.internal.builder.TaxEndPointBuilder
public class TaxEndPointBuilder extends Object
tax エンドポイントにリクエストを送るためのビルダークラスです。
関連項目:

  • メソッドの詳細

    • createWithId

      public static TaxEndPointBuilder createWithId(int id)
      tax エンドポイントのリクエストを、API内部管理IDを指定して作成します。

      このIDは楽曲DB内で使用されている管理IDであり、通常はlistなどで検索をかけてからAPI文字列より、リクエストを作成する方法が便利です

      パラメータ:
      id - 指定する楽曲などAPI内部管理ID
      戻り値:
      IDを指定した新しい TaxEndPointBuilder

    • createWithIdolName

      public static TaxEndPointBuilder createWithIdolName(String name)
      tax エンドポイントのリクエストをアイドル名を指定して作成します。

      苗字と名前の間にはスペースなどをおく必要はありません。例：藤居朋

      パラメータ:
      name - アイドル名（苗字と名前の間のスペースなし）
      戻り値:
      アイドル名を指定した新しい TaxEndPointBuilder

    • createWithUnitName

      public static TaxEndPointBuilder createWithUnitName(String name)
      tax エンドポイントのリクエストをユニット名完全一致で指定して作成します。

      **注意**

      ユニット名は表記ゆれが激しいため、完全一致では目的のデータを取得できない可能性があります。部分一致検索は [@code list} エンドポイントを利用してください。

      パラメータ:
      name - ユニット名（完全一致）
      戻り値:
      ユニット名を指定した新しい TaxEndPointBuilder

    • createWithLiveDate

      public static TaxEndPointBuilder createWithLiveDate(String liveDate)
      tax エンドポイントのリクエストをライブが開催された日付を基に作成します。

      同じ日にライブがあるなどの場合を除き、「yyyy-mm-dd」形式のみ受け付け。

      パラメータ:
      liveDate - 指定するライブの日付 yyyy-mm-dd
      戻り値:
      ライブの日付を指定した新しい TaxEndPointBuilder

    • setLimit

      public TaxEndPointBuilder setLimit(int limit)
      出力するデータの上限数を設定します。
      パラメータ:
      limit - 出力するデータの上限（自然数）
      戻り値:
      チェーンを組むためのこのインスタンス

    • setMusicType

      public TaxEndPointBuilder setMusicType(TaxParameter.MusicType... type)
      楽曲の種類を指定します。

      この情報は複数指定可能です。

      パラメータ:
      type - 指定する楽曲の種類
      戻り値:
      チェーンを組むためのこのインスタンス
      関連項目:

    • setOrderBy

      public TaxEndPointBuilder setOrderBy(TaxParameter.OrderBy orderBy)
      データの出力の際、ソート基準となるアイテムを指定します
      パラメータ:
      orderBy - 基準とするアイテム
      戻り値:
      チェーンのためのこのインスタンス

    • setOrder

      public TaxEndPointBuilder setOrder(TaxParameter.Order order)
      出力データを昇順でソートするか、降順でソートするかを指定します。
      パラメータ:
      order - 昇順降順の指定
      戻り値:
      チェーンのためのこのインスタンス

    • build

      public RestAction<TaxEndPoint> build()
      各種パラメータで指定された情報を使用して、リクエストを送信するためのインスタンスを作成して返します。

      この時点ではまだリクエストは送信されていないことに注意してください。

      戻り値:
      tax エンドポイントへリクエストを送信するためのインスタンス