クラス Jackson2ObjectMapperBuilder

メソッドの詳細

• createXmlMapper

  public Jackson2ObjectMapperBuilder createXmlMapper(boolean createXmlMapper)

  true に設定すると、デフォルトのコンストラクターを使用して XmlMapper が作成されます。これは、configure(com.fasterxml.jackson.databind.ObjectMapper) コールではなく、build() コールにのみ適用されます。

• factory

  public Jackson2ObjectMapperBuilder factory(JsonFactory factory)

  ObjectMapper インスタンスの作成に使用される JsonFactory を定義します。

  導入:

  5.0

• dateFormat

  public Jackson2ObjectMapperBuilder dateFormat(DateFormatSE dateFormat)

  指定された DateFormatSE で日付 / 時刻の形式を定義します。

  メモ: このプロパティを設定すると、Jackson のスレッドセーフルールに従って、公開された ObjectMapper が非スレッドセーフになります。

  関連事項:

  • simpleDateFormat(String)

• simpleDateFormat

  public Jackson2ObjectMapperBuilder simpleDateFormat(StringSE format)

  SimpleDateFormatSE を使用して日付 / 時刻形式を定義します。

  メモ: このプロパティを設定すると、Jackson のスレッドセーフルールに従って、公開された ObjectMapper が非スレッドセーフになります。

  関連事項:

  • dateFormat(DateFormat)

• locale

  public Jackson2ObjectMapperBuilder locale(LocaleSE locale)

  フォーマットに使用するデフォルトの LocaleSE をオーバーライドします。

  使用されるデフォルト値は Locale.getDefault() です。

  導入:

  4.1.5

• locale

  public Jackson2ObjectMapperBuilder locale(StringSE localeString)

  フォーマットに使用するデフォルトの LocaleSE をオーバーライドします。

  使用されるデフォルト値は Locale.getDefault() です。

  パラメーター:

  localeString - 文字列表現としてのロケール ID

  導入:

  4.1.5

• timeZone

  public Jackson2ObjectMapperBuilder timeZone(TimeZoneSE timeZone)

  フォーマットに使用するデフォルトの TimeZoneSE をオーバーライドします。

  使用されるデフォルト値は UTC (ローカルタイムゾーンではありません) です。

  導入:

  4.1.5

• timeZone

  public Jackson2ObjectMapperBuilder timeZone(StringSE timeZoneString)

  フォーマットに使用するデフォルトの TimeZoneSE をオーバーライドします。

  使用されるデフォルト値は UTC (ローカルタイムゾーンではありません) です。

  パラメーター:

  timeZoneString - 文字列表現としてのゾーン ID

  導入:

  4.1.5

• annotationIntrospector

  public Jackson2ObjectMapperBuilder annotationIntrospector(AnnotationIntrospector annotationIntrospector)

  シリアライゼーションとデシリアライゼーションの両方に AnnotationIntrospector を設定します。

• annotationIntrospector

  public Jackson2ObjectMapperBuilder annotationIntrospector(FunctionSE<AnnotationIntrospector,AnnotationIntrospector> pairingFunction)

  annotationIntrospector(AnnotationIntrospector) の代替であり、現在設定されているイントロスペクターを置き換えるのではなく、たとえば AnnotationIntrospector.pair(AnnotationIntrospector, AnnotationIntrospector) を介して組み合わせることができます。

  パラメーター:

  pairingFunction - 現在設定されているイントロスペクター（おそらく null）に適用する関数。関数の結果が新しいイントロスペクターになります。

  導入:

  5.2.4

• propertyNamingStrategy

  public Jackson2ObjectMapperBuilder propertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy)

  PropertyNamingStrategy を指定して、ObjectMapper を構成します。

• defaultTyping

  public Jackson2ObjectMapperBuilder defaultTyping(TypeResolverBuilder<?> typeResolverBuilder)

  Jackson のデフォルトの入力に使用する TypeResolverBuilder を指定します。

  導入:

  4.2.2

• serializationInclusion

  public Jackson2ObjectMapperBuilder serializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include inclusion)

  直列化のカスタム包含戦略を設定します。

  関連事項:

  • JsonInclude.Include

• serializationInclusion

  public Jackson2ObjectMapperBuilder serializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Value serializationInclusion)

  直列化のカスタム包含戦略を設定します。

  導入:

  5.3

  関連事項:

  • JsonInclude.Value

• filters

  public Jackson2ObjectMapperBuilder filters(FilterProvider filters)

  @JsonFilter アノテーション付き POJO をサポートするために使用するグローバルフィルターを設定します。

  導入:

  4.2

  関連事項:

  • MappingJacksonValue.setFilters(FilterProvider)

• mixIn

  public Jackson2ObjectMapperBuilder mixIn(ClassSE<?> target, ClassSE<?> mixinSource)

  指定されたクラスまたはインターフェースを補強するために使用するミックスインアノテーションを追加します。

  パラメーター:

  target - アノテーションが効果的にオーバーライドされるクラス（またはインターフェース）

  mixinSource - そのアノテーションが値としてターゲットのアノテーションに「追加」されるクラス（またはインターフェース）

  導入:

  4.1.2

  関連事項:

  • ObjectMapper.addMixIn(Class, Class)

• mixIns

  public Jackson2ObjectMapperBuilder mixIns(MapSE<ClassSE<?>,ClassSE<?>> mixIns)

  指定されたクラスまたはインターフェースを補強するために使用するミックスインアノテーションを追加します。

  パラメーター:

  mixIns - アノテーションがキーとして効果的にオーバーライドされるターゲットクラス（またはインターフェース）と、アノテーションが値としてターゲットのアノテーションに「追加」されるミックスインクラス（またはインターフェース）を持つエントリのマップ。

  導入:

  4.1.2

  関連事項:

  • ObjectMapper.addMixIn(Class, Class)

• serializers

  public Jackson2ObjectMapperBuilder serializers(JsonSerializer<?>... serializers)

  カスタムシリアライザーを構成します。各シリアライザーは、JsonSerializer.handledType() によって返される型用に登録されますが、null であってはなりません。

  関連事項:

  • serializersByType(Map)

• serializerByType

  public Jackson2ObjectMapperBuilder serializerByType(ClassSE<?> type, JsonSerializer<?> serializer)

  指定した型のカスタムシリアライザーを構成します。

  導入:

  4.1.2

  関連事項:

  • serializers(JsonSerializer...)

• serializersByType

  public Jackson2ObjectMapperBuilder serializersByType(MapSE<ClassSE<?>,JsonSerializer<?>> serializers)

  指定された型のカスタムシリアライザーを構成します。

  関連事項:

  • serializers(JsonSerializer...)

• deserializers

  public Jackson2ObjectMapperBuilder deserializers(JsonDeserializer<?>... deserializers)

  カスタムデシリアライザーを構成します。各デシリアライザは、JsonDeserializer.handledType() によって返される型に対して登録されますが、null であってはなりません。

  導入:

  4.3

  関連事項:

  • deserializersByType(Map)

• deserializerByType

  public Jackson2ObjectMapperBuilder deserializerByType(ClassSE<?> type, JsonDeserializer<?> deserializer)

  指定した型のカスタムデシリアライザーを構成します。

  導入:

  4.1.2

• deserializersByType

  public Jackson2ObjectMapperBuilder deserializersByType(MapSE<ClassSE<?>,JsonDeserializer<?>> deserializers)

  指定された型のカスタムデシリアライザーを構成します。

• autoDetectFields

  public Jackson2ObjectMapperBuilder autoDetectFields(boolean autoDetectFields)

  MapperFeature.AUTO_DETECT_FIELDS オプションのショートカット。

• autoDetectGetterSetter

  public Jackson2ObjectMapperBuilder autoDetectGettersSetters(boolean autoDetectGettersSetters)

  MapperFeature.AUTO_DETECT_SETTERS/MapperFeature.AUTO_DETECT_GETTERS/MapperFeature.AUTO_DETECT_IS_GETTERS オプションのショートカット。

• defaultViewInclusion

  public Jackson2ObjectMapperBuilder defaultViewInclusion(boolean defaultViewInclusion)

  MapperFeature.DEFAULT_VIEW_INCLUSION オプションのショートカット。

• failOnUnknownProperties

  public Jackson2ObjectMapperBuilder failOnUnknownProperties(boolean failOnUnknownProperties)

  DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES オプションのショートカット。

• failOnEmptyBeans

  public Jackson2ObjectMapperBuilder failOnEmptyBeans(boolean failOnEmptyBeans)

  SerializationFeature.FAIL_ON_EMPTY_BEANS オプションのショートカット。

• indentOutput

  public Jackson2ObjectMapperBuilder indentOutput(boolean indentOutput)

  SerializationFeature.INDENT_OUTPUT オプションのショートカット。

• defaultUseWrapper

  public Jackson2ObjectMapperBuilder defaultUseWrapper(boolean defaultUseWrapper)

  ラッパーがインデックス付き（リスト、配列）プロパティに使用されるかどうかを定義します（既定では使用されません（XmlMapper のみに適用されます））。

  導入:

  4.3

• visibility

  public Jackson2ObjectMapperBuilder visibility(com.fasterxml.jackson.annotation.PropertyAccessor accessor, com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility visibility)

  自動検出されるプロパティの種類を制限するには、可視性を指定します。

  導入:

  5.1

  関連事項:

  • PropertyAccessor
  • JsonAutoDetect.Visibility

• featuresToEnable

  public Jackson2ObjectMapperBuilder featuresToEnable(ObjectSE... featuresToEnable)

  有効にする機能を指定します。

  関連事項:

  • JsonParser.Feature
  • JsonGenerator.Feature
  • SerializationFeature
  • DeserializationFeature
  • MapperFeature

• featuresToDisable

  public Jackson2ObjectMapperBuilder featuresToDisable(ObjectSE... featuresToDisable)

  無効にする機能を指定します。

  関連事項:

  • JsonParser.Feature
  • JsonGenerator.Feature
  • SerializationFeature
  • DeserializationFeature
  • MapperFeature

• modules

  public Jackson2ObjectMapperBuilder modules(Module... modules)

  ObjectMapper に登録するモジュールを指定します。

  複数の呼び出しは追加されません。最後の呼び出しで登録するモジュールが定義されます。

  メモ: これが設定されている場合、モジュールの自動検出は行われません。Jackson でも Spring でも行われません (findModulesViaServiceLoader を参照)。結果として、ここで空のリストを指定すると、あらゆる種類のモジュール検出が抑制されます。

  これまたは modulesToInstall(com.fasterxml.jackson.databind.Module...) の両方ではなく、いずれかを指定します。

  導入:

  4.1.5

  関連事項:

  • modules(List)
  • Module

• modules

  public Jackson2ObjectMapperBuilder modules(ListSE<Module> modules)

  ListSE を使用した modules(Module...) のバリアント。

  関連事項:

  • modules(Module...)
  • modules(Consumer)
  • Module

• modules

  public Jackson2ObjectMapperBuilder modules(ConsumerSE<ListSE<Module>> consumer)

  モジュールの基礎となるリストを完全に制御するための ConsumerSE を備えた modules(Module...) のバリアント。

  導入:

  5.3.22

  関連事項:

  • modules(Module...)
  • modules(List)
  • Module

• modulesToInstall

  public Jackson2ObjectMapperBuilder modulesToInstall(Module... modules)

  ObjectMapper に登録する 1 つ以上のモジュールを指定します。

  複数の呼び出しは追加されません。最後の呼び出しで登録するモジュールが定義されます。

  ここで指定されたモジュールは、Spring による JSR-310 の自動検出、または Jackson によるモジュールの検出 (findModulesViaServiceLoader を参照) 後に登録され、最終的にその構成を上書きできるようになります。

  これまたは modules(Module...) の両方ではなく、いずれかを指定します。

  導入:

  4.1.5

  関連事項:

  • modulesToInstall(Consumer)
  • modulesToInstall(Class...)
  • Module

• modulesToInstall

  public Jackson2ObjectMapperBuilder modulesToInstall(ConsumerSE<ListSE<Module>> consumer)

  モジュールの基礎となるリストを完全に制御するための ConsumerSE を備えた modulesToInstall(Module...) のバリアント。

  導入:

  5.3.22

  関連事項:

  • modulesToInstall(Module...)
  • modulesToInstall(Class...)
  • Module

• modulesToInstall

  @SafeVarargsSE public final Jackson2ObjectMapperBuilder modulesToInstall(ClassSE<? extends Module>... modules)

  ObjectMapper に登録する 1 つ以上のモジュールをクラスごとに指定します。

  複数の呼び出しは追加されません。最後の呼び出しで登録するモジュールが定義されます。

  ここで指定されたモジュールは、Spring による JSR-310 の自動検出、または Jackson によるモジュールの検出 (findModulesViaServiceLoader を参照) 後に登録され、最終的にその構成を上書きできるようになります。

  これまたは modules(Module...) の両方ではなく、いずれかを指定します。

  関連事項:

  • modulesToInstall(Module...)
  • modulesToInstall(Consumer)
  • Module

• findModulesViaServiceLoader

  public Jackson2ObjectMapperBuilder findModulesViaServiceLoader(boolean findModules)

  クラスパス内の META-INF メタデータに基づいて、Jackson が JDK ServiceLoader を介して使用可能なモジュールを検索するかどうかを設定します。

  このモードが設定されていない場合、Spring の Jackson2ObjectMapperBuilder 自体がクラスパス上で JSR-310 サポートモジュールを見つけようとします。

  関連事項:

  • ObjectMapper.findModules()

• moduleClassLoader

  public Jackson2ObjectMapperBuilder moduleClassLoader(ClassLoaderSE moduleClassLoader)

  Jackson 拡張モジュールのロードに使用する ClassLoader を設定します。

• handlerInstantiator

  public Jackson2ObjectMapperBuilder handlerInstantiator(HandlerInstantiator handlerInstantiator)

  Jackson ハンドラー（JsonSerializer、JsonDeserializer、KeyDeserializer、TypeResolverBuilder および TypeIdResolver）の構成をカスタマイズします。

  導入:

  4.1.3

  関連事項:

  • applicationContext(ApplicationContext)

• applicationContext

  public Jackson2ObjectMapperBuilder applicationContext(ApplicationContext applicationContext)

  Jackson ハンドラー（JsonSerializer、JsonDeserializer、KeyDeserializer、TypeResolverBuilder および TypeIdResolver）をオートワイヤーするために、Spring ApplicationContext を設定します。

  導入:

  4.1.3

  関連事項:

  • SpringHandlerInstantiator

• postConfigurer

  public Jackson2ObjectMapperBuilder postConfigurer(ConsumerSE<ObjectMapper> configurer)

  ビルダーの他のすべての構成プロパティが適用された後、最後に ObjectMapper インスタンスに直接追加のカスタマイズを適用するオプション。

  パラメーター:

  configurer - 適用するコンフィギュレーター。複数のコンフィギュレーターが登録されている場合、登録順に適用されます。

  導入:

  5.3

• build

  public <T extends ObjectMapper> T build()

  新しい ObjectMapper インスタンスを作成します。

  ビルド操作ごとに、独立した ObjectMapper インスタンスが生成されます。ビルダーの設定を変更して、その後のビルド操作で最新の設定に基づいて新しい ObjectMapper を作成できます。

  戻り値:

  新しく構築された ObjectMapper

• configure

  public void configure(ObjectMapper objectMapper)

  このビルダーの設定を使用して、既存の ObjectMapper インスタンスを構成します。これは、任意の数の ObjectMappers に適用できます。

  パラメーター:

  objectMapper - 設定する ObjectMapper

• json

  public static Jackson2ObjectMapperBuilder json()

  通常の JSON ObjectMapper インスタンスを構築するには、Jackson2ObjectMapperBuilder インスタンスを取得します。

• xml

  public static Jackson2ObjectMapperBuilder xml()

  XmlMapper インスタンスを構築するには、Jackson2ObjectMapperBuilder インスタンスを取得します。

• smile

  public static Jackson2ObjectMapperBuilder smile()

  Smile データ形式 ObjectMapper インスタンスを構築するために、Jackson2ObjectMapperBuilder インスタンスを取得してください。

  導入:

  5.0

• cbor

  public static Jackson2ObjectMapperBuilder cbor()

  Jackson2ObjectMapperBuilder インスタンスを取得して、CBOR データ形式の ObjectMapper インスタンスを構築します。

  導入:

  5.0

• yaml

  public static Jackson2ObjectMapperBuilder yaml()

  YAML データ形式の ObjectMapper インスタンスを構築するには、Jackson2ObjectMapperBuilder インスタンスを取得します。

  導入:

  6.2