パッケージ jakarta.json.bind
クラス JsonbConfig
java.lang.ObjectSE
jakarta.json.bind.JsonbConfig
このオブジェクトはスレッドセーフではありません。実装では、構成を適用する前にオブジェクトの防御コピーを作成することが期待されています。すべての JSON バインディングプロバイダーは、次の一連のプロパティをサポートする必要があります。一部のプロバイダーは追加のプロパティをサポートしている場合があります。
jsonb.to.json.formatted
- java.lang.BooleanJsonb
toJson()
メソッドが、結果の JSON データを改行とインデントでフォーマットするかどうかを制御します。このプロパティの true 値は人間が読めるインデントされたデータを示し、false 値はフォーマットされていないデータを示します。このプロパティが指定されていない場合、デフォルト値は false(未フォーマット)です。
jsonb.to.json.encoding
- java.lang.StringJsonb
シリアライゼーションtoJson()
メソッドは、出力 JSON データをエンコードするためにデフォルトでこのプロパティになります。このプロパティが指定されていない場合、デフォルト値は "UTF-8" です。
jsonb.from.json.encoding
- java.lang.StringJsonb
逆直列化fromJson()
メソッドは、エンコーディングが検出できない場合、デフォルトで入力 JSON データのこのプロパティエンコーディングになります。
- 導入:
- JSON バインディング 1.0
フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSE
ジェネリクス型のカスタムマッピングアダプターを指定するために使用されるプロパティ。static final StringSE
カスタムバイナリデータ戦略を指定するために使用されるプロパティ。static final StringSE
必要なクリエーターパラメーターを指定するために使用されるプロパティ。static final StringSE
カスタム日付形式をグローバルに指定するために使用されるプロパティ。static final StringSE
カスタムデシリアライザーを指定するために使用されるプロパティ。static final StringSE
Jsonb シリアライゼーションtoJson()
メソッドは、出力 JSON データのエンコーディング用にデフォルトでこのプロパティになります。static final StringSE
直列化された JSON データが改行とインデントでフォーマットされるかどうかを指定するために使用されるプロパティ。static final StringSE
ロケールをグローバルに指定するために使用されるプロパティ。static final StringSE
null 値の直列化動作を指定するために使用されるプロパティ。static final StringSE
カスタム命名戦略を指定するために使用されるプロパティ。static final StringSE
カスタムオーダー戦略を指定するために使用されるプロパティ。static final StringSE
カスタム可視性戦略を指定するために使用されるプロパティ。static final StringSE
カスタムシリアライザーを指定するために使用されるプロパティ。static final StringSE
厳密な I-JSON 直列化準拠を指定するために使用されるプロパティ。コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明getAsMap()
すべての構成プロパティを変更不可能なマップとして返します。final OptionalSE<ObjectSE>
getProperty
(StringSE name) 特定の構成プロパティの戻り値。final JsonbConfig
setProperty
(StringSE name, ObjectSE value) 特定の構成プロパティを新しい値に設定します。final JsonbConfig
withAdapters
(JsonbAdapter... adapters) カスタムマッピングアダプターを指定するために使用されるプロパティ。final JsonbConfig
withBinaryDataStrategy
(StringSE binaryDataStrategy) カスタムバイナリデータ戦略を指定するために使用されるプロパティ。final JsonbConfig
withCreatorParametersRequired
(boolean requiredParameters) すべてのクリエーターパラメーターを必須として扱うかどうかを指定するために使用されるプロパティ。final JsonbConfig
withDateFormat
(StringSE dateFormat, LocaleSE locale) カスタム日付形式を指定するために使用されるプロパティ。final JsonbConfig
withDeserializers
(JsonbDeserializer... deserializers) カスタムデシリアライザーを指定するために使用されるプロパティ。final JsonbConfig
withEncoding
(StringSE encoding) バインディング操作は、JSON データのエンコード用にこのプロパティにデフォルト設定されます。final JsonbConfig
withFormatting
(BooleanSE formatted) 直列化された JSON データが改行とインデントでフォーマットされるかどうかを指定するために使用されるプロパティ。final JsonbConfig
withLocale
(LocaleSE locale) カスタムロケールを指定するために使用されるプロパティ。final JsonbConfig
withNullValues
(BooleanSE serializeNullValues) null 値を JSON ドキュメントに直列化するか、スキップするかを指定するために使用されるプロパティ。final JsonbConfig
withPropertyNamingStrategy
(PropertyNamingStrategy propertyNamingStrategy) カスタム命名戦略を指定するために使用されるプロパティ。final JsonbConfig
withPropertyNamingStrategy
(StringSE propertyNamingStrategy) カスタム命名戦略を指定するために使用されるプロパティ。final JsonbConfig
withPropertyOrderStrategy
(StringSE propertyOrderStrategy) プロパティの順序戦略を指定するために使用されるプロパティ。final JsonbConfig
withPropertyVisibilityStrategy
(PropertyVisibilityStrategy propertyVisibilityStrategy) カスタムプロパティの可視性戦略を指定するために使用されるプロパティ。final JsonbConfig
withSerializers
(JsonbSerializer... serializers) カスタムシリアライザーを指定するために使用されるプロパティ。final JsonbConfig
withStrictIJSON
(BooleanSE enabled) 厳密な I-JSON 直列化コンプライアンスを適用するかどうかを指定するために使用されるプロパティ。
フィールドの詳細
FORMATTING
直列化された JSON データが改行とインデントでフォーマットされるかどうかを指定するために使用されるプロパティ。- 関連事項:
ENCODING
Jsonb 直列化toJson()
メソッドは、出力 JSON データのエンコード用にデフォルトでこのプロパティになります。デフォルト値は "UTF-8" です。Jsonb 逆直列化fromJson()
メソッドは、エンコードが自動的に検出されない場合、デフォルトで入力 JSON データのこのプロパティエンコードになります。- 関連事項:
PROPERTY_NAMING_STRATEGY
カスタム命名戦略を指定するために使用されるプロパティ。- 関連事項:
PROPERTY_ORDER_STRATEGY
カスタムオーダー戦略を指定するために使用されるプロパティ。- 関連事項:
NULL_VALUES
null 値の直列化動作を指定するために使用されるプロパティ。- 関連事項:
STRICT_IJSON
厳密な I-JSON 直列化準拠を指定するために使用されるプロパティ。- 関連事項:
PROPERTY_VISIBILITY_STRATEGY
カスタム可視性戦略を指定するために使用されるプロパティ。- 関連事項:
ADAPTERS
ジェネリクス型のカスタムマッピングアダプターを指定するために使用されるプロパティ。- 関連事項:
SERIALIZERS
カスタムシリアライザーを指定するために使用されるプロパティ。- 関連事項:
DESERIALIZERS
カスタムデシリアライザーを指定するために使用されるプロパティ。- 関連事項:
BINARY_DATA_STRATEGY
カスタムバイナリデータ戦略を指定するために使用されるプロパティ。- 関連事項:
DATE_FORMAT
カスタム日付形式をグローバルに指定するために使用されるプロパティ。- 関連事項:
LOCALE
ロケールをグローバルに指定するために使用されるプロパティ。- 関連事項:
CREATOR_PARAMETERS_REQUIRED
必要なクリエーターパラメーターを指定するために使用されるプロパティ。- 関連事項:
コンストラクターの詳細
JsonbConfig
public JsonbConfig()
メソッドの詳細
setProperty
特定の構成プロパティを新しい値に設定します。このメソッドは、このクラスで定義されている標準の JSON バインディングプロパティの 1 つ、またはプロバイダー固有のプロパティを設定するためにのみ使用できます。- パラメーター:
name
- 設定するプロパティの名前。この値は、定数フィールドの 1 つまたはユーザー指定の文字列を使用して指定できます。value
- 設定するプロパティの値- 戻り値:
- この JsonbConfig インスタンス。
- 例外:
NullPointerExceptionSE
- name パラメーターが null の場合。
getProperty
特定の構成プロパティの戻り値。このメソッドは、このクラスで定義されている標準の JSON バインディングプロパティの 1 つ、またはプロバイダー固有のプロパティを取得するためにのみ使用できます。未定義のプロパティを取得しようとすると、オプションの値が空になります。サポートされているプロパティを参照してください。- パラメーター:
name
- 取得するプロパティの名前- 戻り値:
- リクエストされたプロパティの値
- 例外:
NullPointerExceptionSE
- name パラメーターが null の場合。
getAsMap
すべての構成プロパティを変更不可能なマップとして返します。- 戻り値:
- 変更不可能なマップとしてのすべての構成プロパティ
withFormatting
直列化された JSON データが改行とインデントでフォーマットされるかどうかを指定するために使用されるプロパティ。FORMATTING
プロパティの値を構成します。- パラメーター:
formatted
- True は直列化されたデータがフォーマットされていることを意味し、false(デフォルト)はフォーマットされていないことを意味します。- 戻り値:
- この JsonbConfig インスタンス。
withNullValues
null 値を JSON ドキュメントに直列化するかスキップするかを指定するために使用されるプロパティ。NULL_VALUES
プロパティの値を構成します。- パラメーター:
serializeNullValues
- True は、null 値が JSON ドキュメントに直列化されることを意味します。そうでない場合、事実上スキップされます。- 戻り値:
- この JsonbConfig インスタンス。
withEncoding
バインディング操作では、JSON データのエンコードにこのプロパティがデフォルトで使用されます。入力データ (fromJson) の場合、エンコードを自動的に検出できない場合は、選択したエンコードが使用されます。デフォルト値は "UTF-8" です。ENCODING
プロパティの値を構成します。- パラメーター:
encoding
- RFC 7159 で定義され、Java プラットフォームでサポートされている有効な文字エンコード。- 戻り値:
- この JsonbConfig インスタンス。
withStrictIJSON
厳密な I-JSON 直列化コンプライアンスを適用するかどうかを指定するために使用されるプロパティ。STRICT_IJSON
プロパティの値を構成します。- パラメーター:
enabled
- True は、RFC7493 に従って厳密に準拠してデータが直列化されることを意味します。- 戻り値:
- この JsonbConfig インスタンス。
withPropertyNamingStrategy
カスタム命名戦略を指定するために使用されるプロパティ。PROPERTY_NAMING_STRATEGY
プロパティの値を構成します。- パラメーター:
propertyNamingStrategy
- 直列化と逆直列化に影響を与えるカスタム命名戦略。- 戻り値:
- この JsonbConfig インスタンス。
withPropertyNamingStrategy
カスタム命名戦略を指定するために使用されるプロパティ。PROPERTY_NAMING_STRATEGY
プロパティの値を構成します。- パラメーター:
propertyNamingStrategy
- 直列化と逆直列化に影響を与える事前定義された命名戦略。- 戻り値:
- この JsonbConfig インスタンス。
withPropertyOrderStrategy
プロパティの順序戦略を指定するために使用されるプロパティ。PROPERTY_ORDER_STRATEGY
プロパティの値を構成します。- パラメーター:
propertyOrderStrategy
- 直列化に影響を与える事前定義されたプロパティ順序戦略。- 戻り値:
- この JsonbConfig インスタンス。
withPropertyVisibilityStrategy
public final JsonbConfig withPropertyVisibilityStrategy(PropertyVisibilityStrategy propertyVisibilityStrategy) カスタムプロパティの可視性戦略を指定するために使用されるプロパティ。PROPERTY_VISIBILITY_STRATEGY
プロパティの値を構成します。- パラメーター:
propertyVisibilityStrategy
- 直列化と逆直列化に影響を与えるカスタムプロパティの可視性戦略。- 戻り値:
- この JsonbConfig インスタンス。
withAdapters
カスタムマッピングアダプターを指定するために使用されるプロパティ。ADAPTERS
プロパティの値を構成します。withAdapters を複数回呼び出すと、アダプターが以前の値とマージされます。- パラメーター:
adapters
- 直列化と逆直列化に影響を与えるカスタムマッピングアダプター。- 戻り値:
- この JsonbConfig インスタンス。
withSerializers
カスタムシリアライザーを指定するために使用されるプロパティ。SERIALIZERS
プロパティの値を構成します。withSerializers を複数回呼び出すと、シリアライザーが以前の値とマージされます。- パラメーター:
serializers
- 直列化に影響を与えるカスタムシリアライザー。- 戻り値:
- この JsonbConfig インスタンス。
withDeserializers
カスタムデシリアライザーを指定するために使用されるプロパティ。DESERIALIZERS
プロパティの値を構成します。withDeserializers を複数回呼び出すと、デシリアライザーが以前の値とマージされます。- パラメーター:
deserializers
- デシリアライズに影響を与えるカスタムデシリアライザー。- 戻り値:
- この JsonbConfig インスタンス。
withBinaryDataStrategy
カスタムバイナリデータ戦略を指定するために使用されるプロパティ。BINARY_DATA_STRATEGY
プロパティの値を構成します。- パラメーター:
binaryDataStrategy
- 直列化と逆直列化に影響を与えるカスタムバイナリデータ戦略。- 戻り値:
- この JsonbConfig インスタンス。
withDateFormat
カスタム日付形式を指定するために使用されるプロパティ。この形式は、すべての日付クラスの直列化と逆直列化にデフォルトで使用されます。DATE_FORMAT
およびLOCALE
プロパティの値を構成します。- パラメーター:
dateFormat
-DateTimeFormatter
SE で指定されているカスタム日付形式。locale
- ロケール。null が指定されている場合、Locale.getDefault()
が使用されます。- 戻り値:
- この JsonbConfig インスタンス。
withLocale
カスタムロケールを指定するために使用されるプロパティ。LOCALE
プロパティの値を構成します。- パラメーター:
locale
- ロケール、null であってはなりません。- 戻り値:
- この JsonbConfig インスタンス。
withCreatorParametersRequired
すべてのクリエーターパラメーターを必須として扱うかどうかを指定するために使用されるプロパティ。
デフォルト値はfalse
です。- パラメーター:
requiredParameters
- 作成者パラメーターが必要かどうか- 戻り値:
- この JsonbConfig インスタンス。