Packages

case class Builder extends Product with Serializable

A Builder for creating a new ScalaObjectMapper. E.g., to build a new instance of a ScalaObjectMapper.

For example,

ScalaObjectMapper.builder
  .withPropertyNamingStrategy(new PropertyNamingStrategies.UpperCamelCaseStrategy)
  .withNumbersAsStrings(true)
  .withAdditionalJacksonModules(...)
  .objectMapper

or

val builder =
  ScalaObjectMapper.builder
    .withPropertyNamingStrategy(new PropertyNamingStrategies.UpperCamelCaseStrategy)
    .withNumbersAsStrings(true)
    .withAdditionalJacksonModules(...)

  val mapper = builder.objectMapper
  val camelCaseMapper = builder.camelCaseObjectMapper
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val additionalJacksonModules: Seq[Module]
  5. val additionalMapperConfigurationFns: Seq[(ObjectMapper) => Unit]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def camelCaseObjectMapper: ScalaObjectMapper

    Creates a new ScalaObjectMapper explicitly configured with PropertyNamingStrategies.LOWER_CAMEL_CASE as a PropertyNamingStrategy.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val defaultJacksonModules: Seq[Module]
  10. val deserializationConfig: Map[DeserializationFeature, Boolean]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val numbersAsStrings: Boolean
  19. final def objectMapper[F <: JsonFactory](factory: F): ScalaObjectMapper

    Create a new ScalaObjectMapper from this Builder using the given JsonFactory.

  20. final def objectMapper: ScalaObjectMapper

    Create a new ScalaObjectMapper from this Builder.

  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val propertyNamingStrategy: PropertyNamingStrategy
  23. val serializationConfig: Map[SerializationFeature, Boolean]
  24. val serializationInclude: Include
  25. final def snakeCaseObjectMapper: ScalaObjectMapper

    Creates a new ScalaObjectMapper explicitly configured with PropertyNamingStrategies.SNAKE_CASE as a PropertyNamingStrategy.

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val validation: Boolean
  28. val validator: Option[ScalaValidator]
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def withAdditionalJacksonModules(additionalJacksonModules: Seq[Module]): Builder

    Configure the list of additional Jackson Modules for this Builder.

    Configure the list of additional Jackson Modules for this Builder.

    Note

    this will overwrite (not append) the list additional Jackson Modules of this Builder.

  33. final def withAdditionalMapperConfigurationFn(mapperFn: (ObjectMapper) => Unit): Builder

    Configure additional JacksonObjectMapper functionality for the underlying mapper of this Builder.

    Configure additional JacksonObjectMapper functionality for the underlying mapper of this Builder.

    Note

    this will overwrite any previously set function.

  34. final def withDeserializationConfig(deserializationConfig: Map[DeserializationFeature, Boolean]): Builder

    Set the deserialization configuration for this Builder as a Map of DeserializationFeature to Boolean (enabled).

    Set the deserialization configuration for this Builder as a Map of DeserializationFeature to Boolean (enabled).

    Note

    this overwrites the default deserialization configuration of this Builder.

    ,

    the default is described by ScalaObjectMapper.DefaultDeserializationConfig.

    See also

    ScalaObjectMapper.DefaultDeserializationConfig

  35. final def withNoValidation: Builder

    Disable case class validation during case class deserialization

    Disable case class validation during case class deserialization

    Note

    If you pass withNoValidation to the builder all case class validations will be bypassed, regardless of the withValidator configuration.

    See also

    ScalaObjectMapper.DefaultValidation

  36. final def withNumbersAsStrings(numbersAsStrings: Boolean): Builder

    Enable the JsonWriteFeature.WRITE_NUMBERS_AS_STRINGS for this Builder.

    Enable the JsonWriteFeature.WRITE_NUMBERS_AS_STRINGS for this Builder.

    Note

    the default is false.

  37. final def withPropertyNamingStrategy(propertyNamingStrategy: PropertyNamingStrategy): Builder

    Configure a PropertyNamingStrategy for this Builder.

    Configure a PropertyNamingStrategy for this Builder.

    Note

    the default is PropertyNamingStrategies.SNAKE_CASE

    See also

    ScalaObjectMapper.DefaultPropertyNamingStrategy

  38. final def withSerializationConfig(serializationConfig: Map[SerializationFeature, Boolean]): Builder

    Set the serialization configuration for this Builder as a Map of SerializationFeature to Boolean (enabled).

    Set the serialization configuration for this Builder as a Map of SerializationFeature to Boolean (enabled).

    Note

    the default is described by ScalaObjectMapper.DefaultSerializationConfig.

    See also

    ScalaObjectMapper.DefaultSerializationConfig

  39. final def withSerializationInclude(serializationInclude: Include): Builder

    Configure a JsonInclude.Include for serialization for this Builder.

    Configure a JsonInclude.Include for serialization for this Builder.

    Note

    the default is JsonInclude.Include.NON_ABSENT

    See also

    ScalaObjectMapper.DefaultSerializationInclude

  40. final def withValidator(validator: ScalaValidator): Builder

    Configure a ScalaValidator for this Builder

    Configure a ScalaValidator for this Builder

    Note

    If you pass withNoValidation to the builder all case class validations will be bypassed, regardless of the withValidator configuration.

    See also

    ScalaObjectMapper.DefaultValidator

  41. final def yamlObjectMapper: ScalaObjectMapper

    Create a new ScalaObjectMapper explicitly configured to serialize and deserialize YAML from this Builder.

    Create a new ScalaObjectMapper explicitly configured to serialize and deserialize YAML from this Builder.

    Note

    the used PropertyNamingStrategy is defined by the current Builder configuration.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped