public class Jackson2ObjectMapperBuilder
extends java.lang.Object
ObjectMapper
インスタンスを作成するために使用されるビルダー。Jackson のデフォルトプロパティを次のようにカスタマイズします。
また、次の既知のモジュールがクラスパスで検出された場合、自動的に登録します。
Path
のような Java 7 型のサポート Optional
のような他の Java 8 型のサポート Spring 4.3 の時点で、Jackson 2.6 以降と互換性があります。
build()
, configure(ObjectMapper)
, Jackson2ObjectMapperFactoryBean
コンストラクターと説明 |
---|
Jackson2ObjectMapperBuilder() |
修飾子と型 | メソッドと説明 |
---|---|
Jackson2ObjectMapperBuilder | annotationIntrospector(AnnotationIntrospector annotationIntrospector) シリアライゼーションとデシリアライゼーションの両方に AnnotationIntrospector を設定します。 |
Jackson2ObjectMapperBuilder | applicationContext(ApplicationContext applicationContext) Jackson ハンドラー( JsonSerializer 、JsonDeserializer 、KeyDeserializer 、TypeResolverBuilder および TypeIdResolver )をオートワイヤーするために、Spring ApplicationContext を設定します。 |
Jackson2ObjectMapperBuilder | autoDetectFields(boolean autoDetectFields) MapperFeature.AUTO_DETECT_FIELDS オプションのショートカット。 |
Jackson2ObjectMapperBuilder | autoDetectGettersSetters(boolean autoDetectGettersSetters) |
<T extends ObjectMapper> | build() 新しい ObjectMapper インスタンスを作成します。 |
void | configure(ObjectMapper objectMapper) このビルダーの設定を使用して、既存の ObjectMapper インスタンスを構成します。 |
Jackson2ObjectMapperBuilder | createXmlMapper(boolean createXmlMapper) true に設定すると、デフォルトのコンストラクターを使用して XmlMapper が作成されます。 |
Jackson2ObjectMapperBuilder | dateFormat(java.text.DateFormat dateFormat) 指定された DateFormat で日付 / 時刻の形式を定義します。 |
Jackson2ObjectMapperBuilder | defaultTyping(TypeResolverBuilder<?> typeResolverBuilder) Jackson のデフォルトの入力に使用する TypeResolverBuilder を指定します。 |
Jackson2ObjectMapperBuilder | defaultUseWrapper(boolean defaultUseWrapper) ラッパーがインデックス付き(リスト、配列)プロパティに使用されるかどうかを定義します(既定では使用されません( XmlMapper のみに適用されます))。 |
Jackson2ObjectMapperBuilder | defaultViewInclusion(boolean defaultViewInclusion) MapperFeature.DEFAULT_VIEW_INCLUSION オプションのショートカット。 |
Jackson2ObjectMapperBuilder | deserializerByType(java.lang.Class<?> type, JsonDeserializer<?> deserializer) 指定した型のカスタムデシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | deserializers(JsonDeserializer<?>... deserializers) カスタムデシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | deserializersByType(java.util.Map<java.lang.Class<?>,JsonDeserializer<?>> deserializers) 指定された型のカスタムデシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | failOnEmptyBeans(boolean failOnEmptyBeans) SerializationFeature.FAIL_ON_EMPTY_BEANS オプションのショートカット。 |
Jackson2ObjectMapperBuilder | failOnUnknownProperties(boolean failOnUnknownProperties) DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES オプションのショートカット。 |
Jackson2ObjectMapperBuilder | featuresToDisable(java.lang.Object... featuresToDisable) 無効にする機能を指定します。 |
Jackson2ObjectMapperBuilder | featuresToEnable(java.lang.Object... featuresToEnable) 有効にする機能を指定します。 |
Jackson2ObjectMapperBuilder | filters(FilterProvider filters) @JsonFilter アノテーション付き POJO をサポートするために使用するグローバルフィルターを設定します。 |
Jackson2ObjectMapperBuilder | findModulesViaServiceLoader(boolean findModules) クラスパス内の META-INF メタデータに基づいて、Jackson が JDK ServiceLoader を介して使用可能なモジュールを検索するかどうかを設定します。 |
Jackson2ObjectMapperBuilder | handlerInstantiator(HandlerInstantiator handlerInstantiator) Jackson ハンドラー( JsonSerializer 、JsonDeserializer 、KeyDeserializer 、TypeResolverBuilder および TypeIdResolver )の構成をカスタマイズします。 |
Jackson2ObjectMapperBuilder | indentOutput(boolean indentOutput) SerializationFeature.INDENT_OUTPUT オプションのショートカット。 |
static Jackson2ObjectMapperBuilder | json() 通常の JSON ObjectMapper インスタンスを構築するには、Jackson2ObjectMapperBuilder インスタンスを取得します。 |
Jackson2ObjectMapperBuilder | locale(java.util.Locale locale) フォーマットに使用するデフォルトの Locale をオーバーライドします。 |
Jackson2ObjectMapperBuilder | locale(java.lang.String localeString) フォーマットに使用するデフォルトの Locale をオーバーライドします。 |
Jackson2ObjectMapperBuilder | mixIn(java.lang.Class<?> target, java.lang.Class<?> mixinSource) 指定されたクラスまたはインターフェースを補強するために使用するミックスインアノテーションを追加します。 |
Jackson2ObjectMapperBuilder | mixIns(java.util.Map<java.lang.Class<?>,java.lang.Class<?>> mixIns) 指定されたクラスまたはインターフェースを補強するために使用するミックスインアノテーションを追加します。 |
Jackson2ObjectMapperBuilder | moduleClassLoader(java.lang.ClassLoader moduleClassLoader) Jackson 拡張モジュールのロードに使用する ClassLoader を設定します。 |
Jackson2ObjectMapperBuilder | modules(java.util.List<Module> modules) ObjectMapper に登録するモジュールの完全なリストを設定します。 |
Jackson2ObjectMapperBuilder | modules(Module... modules) ObjectMapper に登録する 1 つ以上のモジュールを指定します。 |
Jackson2ObjectMapperBuilder | modulesToInstall(java.lang.Class<? extends Module>... modules) ObjectMapper に登録する 1 つ以上のモジュールをクラスごとに指定します。 |
Jackson2ObjectMapperBuilder | modulesToInstall(Module... modules) ObjectMapper に登録する 1 つ以上のモジュールを指定します。 |
Jackson2ObjectMapperBuilder | propertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy) PropertyNamingStrategy を指定して、ObjectMapper を構成します。 |
Jackson2ObjectMapperBuilder | serializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include serializationInclusion) 直列化のカスタム包含戦略を設定します。 |
Jackson2ObjectMapperBuilder | serializerByType(java.lang.Class<?> type, JsonSerializer<?> serializer) 指定した型のカスタムシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | serializers(JsonSerializer<?>... serializers) カスタムシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | serializersByType(java.util.Map<java.lang.Class<?>,JsonSerializer<?>> serializers) 指定された型のカスタムシリアライザーを構成します。 |
Jackson2ObjectMapperBuilder | simpleDateFormat(java.lang.String format) SimpleDateFormat を使用して日付 / 時刻形式を定義します。 |
Jackson2ObjectMapperBuilder | timeZone(java.lang.String timeZoneString) フォーマットに使用するデフォルトの TimeZone をオーバーライドします。 |
Jackson2ObjectMapperBuilder | timeZone(java.util.TimeZone timeZone) フォーマットに使用するデフォルトの TimeZone をオーバーライドします。 |
static Jackson2ObjectMapperBuilder | xml() XmlMapper インスタンスを構築するには、Jackson2ObjectMapperBuilder インスタンスを取得します。 |
public Jackson2ObjectMapperBuilder createXmlMapper(boolean createXmlMapper)
true
に設定すると、デフォルトのコンストラクターを使用して XmlMapper
が作成されます。これは、configure(com.fasterxml.jackson.databind.ObjectMapper)
コールではなく、build()
コールにのみ適用されます。public Jackson2ObjectMapperBuilder dateFormat(java.text.DateFormat dateFormat)
DateFormat
で日付 / 時刻の形式を定義します。 メモ: このプロパティを設定すると、Jackson のスレッドセーフルールに従って、公開された ObjectMapper
が非スレッドセーフになります。
public Jackson2ObjectMapperBuilder simpleDateFormat(java.lang.String format)
SimpleDateFormat
を使用して日付 / 時刻形式を定義します。 メモ: このプロパティを設定すると、Jackson のスレッドセーフルールに従って、公開された ObjectMapper
が非スレッドセーフになります。
public Jackson2ObjectMapperBuilder locale(java.util.Locale locale)
Locale
をオーバーライドします。使用されるデフォルト値は Locale.getDefault()
です。public Jackson2ObjectMapperBuilder locale(java.lang.String localeString)
Locale
をオーバーライドします。使用されるデフォルト値は Locale.getDefault()
です。localeString
- 文字列表現としてのロケール IDpublic Jackson2ObjectMapperBuilder timeZone(java.util.TimeZone timeZone)
TimeZone
をオーバーライドします。使用されるデフォルト値は UTC です(ローカルタイムゾーンではありません)。public Jackson2ObjectMapperBuilder timeZone(java.lang.String timeZoneString)
TimeZone
をオーバーライドします。使用されるデフォルト値は UTC です(ローカルタイムゾーンではありません)。timeZoneString
- 文字列表現としてのゾーン IDpublic Jackson2ObjectMapperBuilder annotationIntrospector(AnnotationIntrospector annotationIntrospector)
AnnotationIntrospector
を設定します。public Jackson2ObjectMapperBuilder propertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy)
PropertyNamingStrategy
を指定して、ObjectMapper
を構成します。public Jackson2ObjectMapperBuilder defaultTyping(TypeResolverBuilder<?> typeResolverBuilder)
TypeResolverBuilder
を指定します。public Jackson2ObjectMapperBuilder serializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include serializationInclusion)
JsonInclude.Include
public Jackson2ObjectMapperBuilder filters(FilterProvider filters)
@JsonFilter
アノテーション付き POJO をサポートするために使用するグローバルフィルターを設定します。MappingJacksonValue.setFilters(FilterProvider)
public Jackson2ObjectMapperBuilder mixIn(java.lang.Class<?> target, java.lang.Class<?> mixinSource)
target
- アノテーションが効果的にオーバーライドされるクラス(またはインターフェース)mixinSource
- そのアノテーションが値としてターゲットのアノテーションに「追加」されるクラス(またはインターフェース)ObjectMapper.addMixInAnnotations(Class, Class)
public Jackson2ObjectMapperBuilder mixIns(java.util.Map<java.lang.Class<?>,java.lang.Class<?>> mixIns)
mixIns
- アノテーションがキーとして効果的にオーバーライドされるターゲットクラス(またはインターフェース)と、アノテーションが値としてターゲットのアノテーションに「追加」されるミックスインクラス(またはインターフェース)を持つエントリのマップ。ObjectMapper.addMixInAnnotations(Class, Class)
public Jackson2ObjectMapperBuilder serializers(JsonSerializer<?>... serializers)
JsonSerializer.handledType()
によって返される型用に登録されますが、null
であってはなりません。public Jackson2ObjectMapperBuilder serializerByType(java.lang.Class<?> type, JsonSerializer<?> serializer)
serializers(JsonSerializer...)
public Jackson2ObjectMapperBuilder serializersByType(java.util.Map<java.lang.Class<?>,JsonSerializer<?>> serializers)
public Jackson2ObjectMapperBuilder deserializers(JsonDeserializer<?>... deserializers)
JsonDeserializer.handledType()
によって返される型に対して登録されますが、null
であってはなりません。deserializersByType(Map)
public Jackson2ObjectMapperBuilder deserializerByType(java.lang.Class<?> type, JsonDeserializer<?> deserializer)
public Jackson2ObjectMapperBuilder deserializersByType(java.util.Map<java.lang.Class<?>,JsonDeserializer<?>> deserializers)
public Jackson2ObjectMapperBuilder autoDetectFields(boolean autoDetectFields)
MapperFeature.AUTO_DETECT_FIELDS
オプションのショートカット。public Jackson2ObjectMapperBuilder autoDetectGettersSetters(boolean autoDetectGettersSetters)
public Jackson2ObjectMapperBuilder defaultViewInclusion(boolean defaultViewInclusion)
MapperFeature.DEFAULT_VIEW_INCLUSION
オプションのショートカット。public Jackson2ObjectMapperBuilder failOnUnknownProperties(boolean failOnUnknownProperties)
DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
オプションのショートカット。public Jackson2ObjectMapperBuilder failOnEmptyBeans(boolean failOnEmptyBeans)
SerializationFeature.FAIL_ON_EMPTY_BEANS
オプションのショートカット。public Jackson2ObjectMapperBuilder indentOutput(boolean indentOutput)
SerializationFeature.INDENT_OUTPUT
オプションのショートカット。public Jackson2ObjectMapperBuilder defaultUseWrapper(boolean defaultUseWrapper)
XmlMapper
のみに適用されます))。public Jackson2ObjectMapperBuilder featuresToEnable(java.lang.Object... featuresToEnable)
public Jackson2ObjectMapperBuilder featuresToDisable(java.lang.Object... featuresToDisable)
public Jackson2ObjectMapperBuilder modules(Module... modules)
ObjectMapper
に登録する 1 つ以上のモジュールを指定します。 メモ: これが設定されている場合、モジュールの検出は行われません -Jackson でも Spring でもありません(findModulesViaServiceLoader
を参照)。結果として、ここで空のリストを指定すると、あらゆる種類のモジュール検出が抑制されます。
これまたは modulesToInstall(com.fasterxml.jackson.databind.Module...)
の両方ではなく、いずれかを指定します。
modules(List)
, Module
public Jackson2ObjectMapperBuilder modules(java.util.List<Module> modules)
ObjectMapper
に登録するモジュールの完全なリストを設定します。 メモ: これが設定されている場合、モジュールの検出は行われません -Jackson でも Spring でもありません(findModulesViaServiceLoader
を参照)。結果として、ここで空のリストを指定すると、あらゆる種類のモジュール検出が抑制されます。
これまたは modulesToInstall(com.fasterxml.jackson.databind.Module...)
の両方ではなく、いずれかを指定します。
modules(Module...)
, Module
public Jackson2ObjectMapperBuilder modulesToInstall(Module... modules)
ObjectMapper
に登録する 1 つ以上のモジュールを指定します。 ここで指定されたモジュールは、Spring による JSR-310 および Joda-Time の自動検出、または Jackson によるモジュールの検出(findModulesViaServiceLoader
を参照)後に登録され、最終的にそれらの構成をオーバーライドできます。
これまたは modules
の両方ではなく、いずれかを指定します。
Module
public Jackson2ObjectMapperBuilder modulesToInstall(java.lang.Class<? extends Module>... modules)
ObjectMapper
に登録する 1 つ以上のモジュールをクラスごとに指定します。 ここで指定されたモジュールは、Spring による JSR-310 および Joda-Time の自動検出、または Jackson によるモジュールの検出(findModulesViaServiceLoader
を参照)後に登録され、最終的にそれらの構成をオーバーライドできます。
これまたは modules
の両方ではなく、いずれかを指定します。
public Jackson2ObjectMapperBuilder findModulesViaServiceLoader(boolean findModules)
このモードが設定されていない場合、Spring の Jackson2ObjectMapperBuilder 自体は、クラスパス上で JSR-310 および Joda-Time サポートモジュールを見つけようとします。Java 8 および Joda-Time 自体がそれぞれ利用可能である場合。
public Jackson2ObjectMapperBuilder moduleClassLoader(java.lang.ClassLoader moduleClassLoader)
public Jackson2ObjectMapperBuilder handlerInstantiator(HandlerInstantiator handlerInstantiator)
JsonSerializer
、JsonDeserializer
、KeyDeserializer
、TypeResolverBuilder
および TypeIdResolver
)の構成をカスタマイズします。applicationContext(ApplicationContext)
public Jackson2ObjectMapperBuilder applicationContext(ApplicationContext applicationContext)
JsonSerializer
、JsonDeserializer
、KeyDeserializer
、TypeResolverBuilder
および TypeIdResolver
)をオートワイヤーするために、Spring ApplicationContext
を設定します。SpringHandlerInstantiator
public <T extends ObjectMapper> T build()
ObjectMapper
インスタンスを作成します。 ビルド操作ごとに、独立した ObjectMapper
インスタンスが生成されます。ビルダーの設定を変更して、その後のビルド操作で最新の設定に基づいて新しい ObjectMapper
を作成できます。
public void configure(ObjectMapper objectMapper)
ObjectMapper
インスタンスを構成します。これは、任意の数の ObjectMappers
に適用できます。objectMapper
- 設定する ObjectMapperpublic static Jackson2ObjectMapperBuilder json()
ObjectMapper
インスタンスを構築するには、Jackson2ObjectMapperBuilder
インスタンスを取得します。public static Jackson2ObjectMapperBuilder xml()
XmlMapper
インスタンスを構築するには、Jackson2ObjectMapperBuilder
インスタンスを取得します。