パッケージ jakarta.ws.rs.core

クラス Variant.VariantListBuilder

  • 含まれているクラス:
    Variant

    public abstract static class Variant.VariantListBuilder
    extends ObjectSE
    表現バリアントのリストのビルダー。
    • コンストラクターの詳細

      • VariantListBuilder

        protected VariantListBuilder()
        protected コンストラクター。静的 newInstance メソッドを使用してインスタンスを取得します。
    • メソッドの詳細

      • newInstance

        public static Variant.VariantListBuilder newInstance()
        新しいビルダーインスタンスを作成します。
        戻り値:
        新しいビルダーインスタンス。
      • build

        public abstract ListSE<Variant> build()
        サポートされているバリアントのリストにメタデータの現在の組み合わせを追加し(メタデータの現在の組み合わせが空でない場合)、ビルダーの現在の状態から表現バリアントのリストを作成します。このメソッドが呼び出された後、ビルダーは空の状態にリセットされます。
        戻り値:
        表現バリアントのリスト。
      • add

        public abstract Variant.VariantListBuilder add()
        このメソッドが呼び出された後、メタデータの現在の組み合わせが空になり、サポートされているバリアントのリストにメタデータの現在の組み合わせを追加します。

        1 つ以上のバリアントプロパティに複数の値が指定されている場合、可能な組み合わせごとにバリアントが生成されます。例: 次の list には、5 つの(4 + 1)メンバーがあります。

         List<Variant> list = VariantListBuilder.newInstance()
                 .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
                 .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE).add()
                 .build()
         

        build メソッドが呼び出される直前に add() メソッドを呼び出す必要はないことに注意してください。例: 上記の例で作成された結果のリストは、次のコードで作成されたリストと同じになります。

         List<Variant> list = VariantListBuilder.newInstance()
                 .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
                 .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE)
                 .build()
         
        戻り値:
        更新されたビルダー。
        例外:
        IllegalStateExceptionSE - 現在のバリアントに少なくとも 1 つの mediaType、言語、エンコードセットがない場合。
      • languages

        public abstract Variant.VariantListBuilder languages​(LocaleSE... languages)
        このバリアントの言語を設定します。
        パラメーター:
        languages - 利用可能な言語。
        戻り値:
        更新されたビルダー。
      • encodings

        public abstract Variant.VariantListBuilder encodings​(StringSE... encodings)
        このバリアントのエンコーディングを設定します。
        パラメーター:
        encodings - 利用可能なエンコーディング。
        戻り値:
        更新されたビルダー。
      • mediaTypes

        public abstract Variant.VariantListBuilder mediaTypes​(MediaType... mediaTypes)
        このバリアントのメディア型を設定します。
        パラメーター:
        mediaTypes - 利用可能な mediaTypes。特定の文字セットがサポートされている場合は、それぞれのメディア型のパラメーターとして含める必要があります。
        戻り値:
        更新されたビルダー。