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