パッケージ hajimeapi4j.internal.builder

クラス ListEndPointBuilder

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

  • メソッドの詳細

    • createFor

      public static ListEndPointBuilder createFor(String type)
      指定されたtypeを使用して新しいビルダークラスを作成します

      文字列から直接作成することは存在しないパラメータを作成してしまう可能性があるため、createFor(ListParameter.Type) をご利用ください

      パラメータ:
      type - 指定する type
      戻り値:
      チェーンのためのこのインスタンス

    • createFor

      public static ListEndPointBuilder createFor(ListParameter.Type type)
      指定された Type列挙を使用して新しいビルダークラスを作成します
      パラメータ:
      type - 指定する type
      戻り値:
      チェーンのためのこのインスタンス
      関連項目:

    • setLimit

      public ListEndPointBuilder setLimit(int amount)
      出力するデータの上限を設定します。

      このパラメータは ListParameter.Type.MUSIC を指定した場合のみ指定可能です。

      それ以外での呼び出しは UnsupportedOperationException がスローされます

      パラメータ:
      amount - 出力するデータの上限数
      戻り値:
      チェーンのためのこのインスタンス

    • setMusicType

      public ListEndPointBuilder setMusicType(ListParameter.MusicType... types)
      楽曲の種類を指定します。

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

      このパラメータは ListParameter.Type.MUSIC を指定した場合のみ指定可能です

      それ以外での呼び出しは UnsupportedOperationException がスロ－されます

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

    • setOrder

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

    • setOrderBy

      public ListEndPointBuilder setOrderBy(ListParameter.OrderBy orderBy)
      データの出力の際、ソート基準となるアイテムを指定します

      このパラメータは以下の場合に UnsupportedOperationException をスローします

      パラメータ:
      orderBy - 基準とするアイテム
      戻り値:
      チェーンのためのこのインスタンス
      関連項目:

    • setSearch

      public ListEndPointBuilder setSearch(String search)
      検索を掛けるキーワードを指定します。

      この情報は自動的にURLエンコードされ、パラメータが作成されます

      パラメータ:
      search - 検索キーワード
      戻り値:
      チェーンのためのこのインスタンス

    • setProduction

      public ListEndPointBuilder setProduction(ListParameter.Production... production)
      アイドルのプロダクションを指定します

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

      パラメータ:
      production - 指定するプロダクション
      戻り値:
      チェーンのためのこのインスタンス
      関連項目:

    • build

      public RestAction<List<ListEndPoint>> build()
      リクエストを送信するためのインスタンスを作成します

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

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