パッケージ jakarta.json.bind

インターフェース JsonbBuilder

  • public interface JsonbBuilder
    JsonbBuilder クラスは、JSON バインディング API へのクライアントのエントリポイントを提供します。build() メソッドを呼び出す前に提供されたすべてのパラメーターと構成に基づいて Jsonb インスタンスを構築します。ほとんどのユースケースでは、アプリケーション内で JsonbBuilder のインスタンスが 1 つだけ必要です。
    導入:
    JSON バインディング 1.0
    関連事項:
    Jsonb, ServiceLoaderSE

    • メソッドの詳細

      • withConfig

        JsonbBuilder withConfig​(JsonbConfig config)
        新しく作成された Jsonb インスタンスに設定される構成を設定します。
        パラメーター:
        config - Jsonb インスタンスの構成。
        戻り値:
        この JsonbBuilder インスタンス。

      • withProvider

        JsonbBuilder withProvider​(JsonProvider jsonpProvider)
        すべての JSON-P 関連操作に使用される JSON-P プロバイダーを提供します。
        パラメーター:
        jsonpProvider - Jsonb が JSON-P 実装を検索するために使用する JsonProvider インスタンス。
        戻り値:
        この JsonbBuilder インスタンス。

      • build

        Jsonb build()
        このビルダーで以前に指定されたパラメーターと構成に基づいて、Jsonb の新しいインスタンスを返します。
        戻り値:
        Jsonb Jsonb クラスの新しいインスタンス。常に null 以外の有効なオブジェクト。
        例外:
        JsonbException - Jsonb インスタンスの作成中にエラーが発生した場合（JSON バインディングプロバイダーが見つからない（またはこれらに限定されない）など）、またはクラスが競合するアノテーションを提供する場合。
        IllegalArgumentExceptionSE - null 以外のパラメーターなどの設定パラメーターの処理中にエラーが発生した場合は、null 値が割り当てられるか、認識されないプロパティが JsonbConfig に設定されます。

      • create

        static Jsonb create()
        JsonbProvider.provider() メソッドから返されたデフォルトの JsonbBuilder 実装を使用して、新しい Jsonb インスタンスを作成します。
        戻り値:
        新しい Jsonb インスタンス。

      • create

        static Jsonb create​(JsonbConfig config)
        提供された構成で構成された、JsonbProvider.provider() メソッドから返された提供されたデフォルトの JsonbBuilder 実装を使用して、新しい Jsonb インスタンスを作成します。
        パラメーター:
        config - Jsonb インスタンスの設定を提供しました。
        戻り値:
        新しい Jsonb インスタンス。

      • newBuilder

        static JsonbBuilder newBuilder()
        デフォルトの JsonbProvider.provider() メソッドによって返される新しい JsonbBuilder インスタンスを作成します。
        戻り値:
        新しい JsonbBuilder インスタンス。

      • newBuilder

        static JsonbBuilder newBuilder​(StringSE providerName)
        JsonbProvider.provider(String) メソッドによって返される新しい JsonbBuilder インスタンスを作成します。
        パラメーター:
        providerName - ServiceLoaderSE によって検索されるプロバイダークラス名。
        戻り値:
        新しい JsonbBuilder インスタンス。

      • newBuilder

        static JsonbBuilder newBuilder​(JsonbProvider provider)
        provider#create 呼び出しによって返される新しい JsonbBuilder インスタンスを作成します。
        パラメーター:
        provider - JsonBuilder instances の作成に使用される JsonProvider インスタンス。
        戻り値:
        新しい JsonbBuilder インスタンス。