パッケージ jakarta.json.bind
インターフェース JsonbBuilder
public interface JsonbBuilder
JsonbBuilder クラスは、JSON バインディング API へのクライアントのエントリポイントを提供します。
build() メソッドを呼び出す前に提供されたすべてのパラメーターと構成に基づいて Jsonb インスタンスを構築します。ほとんどのユースケースでは、アプリケーション内で JsonbBuilder のインスタンスが 1 つだけ必要です。- 導入:
- JSON バインディング 1.0
- 関連事項:
方法の概要
修飾子と型メソッド説明build()このビルダーで以前に指定されたパラメーターと構成に基づいて、Jsonbの新しいインスタンスを返します。static Jsonbcreate()static Jsonbcreate(JsonbConfig config) 提供された構成で構成された、JsonbProvider.provider()メソッドから返された提供されたデフォルトのJsonbBuilder実装を使用して、新しいJsonbインスタンスを作成します。static JsonbBuilderデフォルトのJsonbProvider.provider()メソッドによって返される新しいJsonbBuilderインスタンスを作成します。static JsonbBuildernewBuilder(JsonbProvider provider) provider#create呼び出しによって返される新しいJsonbBuilderインスタンスを作成します。static JsonbBuildernewBuilder(StringSE providerName) JsonbProvider.provider(String)メソッドによって返される新しいJsonbBuilderインスタンスを作成します。withConfig(JsonbConfig config) 新しく作成されたJsonbインスタンスに設定される構成を設定します。withProvider(JsonProvider jsonpProvider)
メソッドの詳細
withConfig
新しく作成されたJsonbインスタンスに設定される構成を設定します。- パラメーター:
config-Jsonbインスタンスの構成。- 戻り値:
- この
JsonbBuilderインスタンス。
withProvider
- パラメーター:
jsonpProvider- Jsonb が JSON-P 実装を検索するために使用するJsonProviderインスタンス。- 戻り値:
- この
JsonbBuilderインスタンス。
build
Jsonb build()このビルダーで以前に指定されたパラメーターと構成に基づいて、Jsonbの新しいインスタンスを返します。- 戻り値:
- Jsonb
Jsonbクラスの新しいインスタンス。常に null 以外の有効なオブジェクト。 - 例外:
JsonbException- Jsonb インスタンスの作成中にエラーが発生した場合(JSON バインディングプロバイダーが見つからない(またはこれらに限定されない)など)、またはクラスが競合するアノテーションを提供する場合。IllegalArgumentExceptionSE- null 以外のパラメーターなどの設定パラメーターの処理中にエラーが発生した場合は、null 値が割り当てられるか、認識されないプロパティがJsonbConfigに設定されます。
create
- 戻り値:
- 新しい
Jsonbインスタンス。
create
提供された構成で構成された、JsonbProvider.provider()メソッドから返された提供されたデフォルトのJsonbBuilder実装を使用して、新しいJsonbインスタンスを作成します。newBuilder
デフォルトのJsonbProvider.provider()メソッドによって返される新しいJsonbBuilderインスタンスを作成します。- 戻り値:
- 新しい
JsonbBuilderインスタンス。
newBuilder
JsonbProvider.provider(String)メソッドによって返される新しいJsonbBuilderインスタンスを作成します。- パラメーター:
providerName-ServiceLoaderSE によって検索されるプロバイダークラス名。- 戻り値:
- 新しい
JsonbBuilderインスタンス。
newBuilder
provider#create呼び出しによって返される新しいJsonbBuilderインスタンスを作成します。- パラメーター:
provider-JsonBuilder instancesの作成に使用されるJsonProviderインスタンス。- 戻り値:
- 新しい
JsonbBuilderインスタンス。