Object/Class

com.fasterxml.jackson.module.scala

DefaultScalaModule

Related Docs: class DefaultScalaModule | package scala

Permalink

object DefaultScalaModule extends DefaultScalaModule

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultScalaModule
  2. DefaultScalaModule
  3. SymbolModule
  4. SymbolDeserializerModule
  5. SymbolSerializerModule
  6. EitherModule
  7. EitherSerializerModule
  8. EitherTypeModifierModule
  9. EitherDeserializerModule
  10. UntypedObjectDeserializerModule
  11. ScalaAnnotationIntrospectorModule
  12. ScalaObjectDeserializerModule
  13. ScalaNumberDeserializersModule
  14. SetModule
  15. SortedSetDeserializerModule
  16. UnsortedSetDeserializerModule
  17. MapModule
  18. SortedMapDeserializerModule
  19. UnsortedMapDeserializerModule
  20. MapSerializerModule
  21. MapTypeModifierModule
  22. TupleModule
  23. TupleDeserializerModule
  24. TupleSerializerModule
  25. IterableModule
  26. SeqModule
  27. SeqDeserializerModule
  28. IterableSerializerModule
  29. IterableTypeModifierModule
  30. OptionModule
  31. OptionDeserializerModule
  32. OptionSerializerModule
  33. OptionTypeModifierModule
  34. EnumerationModule
  35. EnumerationDeserializerModule
  36. EnumerationSerializerModule
  37. IteratorModule
  38. IteratorSerializerModule
  39. IteratorTypeModifierModule
  40. ScalaTypeModifierModule
  41. JacksonModule
  42. Module
  43. Versioned
  44. AnyRef
  45. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +=(beanSerMod: BeanSerializerModifier): DefaultScalaModule.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    JacksonModule
  4. def +=(typeMod: TypeModifier): DefaultScalaModule.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    JacksonModule
  5. def +=(deser: Deserializers): DefaultScalaModule.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    JacksonModule
  6. def +=(ser: Serializers): DefaultScalaModule.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    JacksonModule
  7. def +=(init: (SetupContext) ⇒ Unit): DefaultScalaModule.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    JacksonModule
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clearRegisteredReferencedTypes(): Unit

    Permalink

    Clears all the state associated with reference types

    Clears all the state associated with reference types

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.13.1

    See also

    clearRegisteredReferencedTypes(Class[_])

    registerReferencedValueType

  11. def clearRegisteredReferencedTypes(clazz: Class[_]): Unit

    Permalink

    clears the state associated with reference types for the given class

    clears the state associated with reference types for the given class

    clazz

    the class for which to remove the registered reference types

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.13.1

    See also

    clearRegisteredReferencedTypes()

    registerReferencedValueType

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def getDependencies(): Iterable[_ <: Module]

    Permalink
    Definition Classes
    Module
  18. def getModuleName(): String

    Permalink
  19. def getRegisteredReferencedValueType(clazz: Class[_], fieldName: String): Option[Class[_]]

    Permalink

    jackson-module-scala does not always properly handle deserialization of Options or Collections wrapping Scala primitives (eg Int, Long, Boolean).

    jackson-module-scala does not always properly handle deserialization of Options or Collections wrapping Scala primitives (eg Int, Long, Boolean).

    This function is experimental and may be removed or significantly reworked in a later release.

    These issues can be worked around by adding Jackson annotations on the affected fields. This function is designed to be used when it is not possible to apply Jackson annotations.

    clazz

    the (case) class

    fieldName

    the field name in the (case) class

    returns

    the referenced type of the field - for Option[Long] - the referenced type is Long

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.13.1

    See also

    registerReferencedValueType

  20. def getTypeId(): AnyRef

    Permalink
    Definition Classes
    Module
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def registerReferencedValueType(clazz: Class[_], fieldName: String, referencedType: Class[_]): Unit

    Permalink

    jackson-module-scala does not always properly handle deserialization of Options or Collections wrapping Scala primitives (eg Int, Long, Boolean).

    jackson-module-scala does not always properly handle deserialization of Options or Collections wrapping Scala primitives (eg Int, Long, Boolean).

    This function is experimental and may be removed or significantly reworked in a later release.

    These issues can be worked around by adding Jackson annotations on the affected fields. This function is designed to be used when it is not possible to apply Jackson annotations.

    clazz

    the (case) class

    fieldName

    the field name in the (case) class

    referencedType

    the referenced type of the field - for Option[Long] - the referenced type is Long

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.13.1

    See also

    clearRegisteredReferencedTypes(Class[_])

    clearRegisteredReferencedTypes()

    getRegisteredReferencedValueType

  27. def setDescriptorCacheSize(size: Int): Unit

    Permalink

    Resize the descriptorCache.

    Resize the descriptorCache. The default size is 100.

    Note that this clears the existing cache entries. It is best to set this up before you start using the Jackson Scala Module for serializing/deserializing.

    size

    new size for the cache

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.14.3

    See also

    setLookupCacheFactory

    setScalaTypeCacheSize

  28. def setLookupCacheFactory(lookupCacheFactory: LookupCacheFactory): Unit

    Permalink

    Replaces the LookupCacheFactory.

    Replaces the LookupCacheFactory. The default factory uses com.fasterxml.jackson.databind.util.LRUMap.

    Note that this clears the existing cache entries. It is best to set this up before you start using the Jackson Scala Module for serializing/deserializing.

    lookupCacheFactory

    new factory

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.14.3

    See also

    setScalaTypeCacheSize

    setDescriptorCacheSize

  29. def setScalaTypeCacheSize(size: Int): Unit

    Permalink

    Resize the scalaTypeCache.

    Resize the scalaTypeCache. The default size is 1000.

    Note that this clears the existing cache entries. It is best to set this up before you start using the Jackson Scala Module for serializing/deserializing.

    size

    new size for the cache

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.14.3

    See also

    setLookupCacheFactory

    setDescriptorCacheSize

  30. def setupModule(context: SetupContext): Unit

    Permalink
    Definition Classes
    JacksonModule → Module
  31. def shouldSupportScala3Classes(): Boolean

    Permalink

    Gets whether we check for Scala3 classes (default is true).

    Gets whether we check for Scala3 classes (default is true).

    returns

    whether we check for Scala3 classes

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.14.0

  32. def supportScala3Classes(support: Boolean): Unit

    Permalink

    Sets whether we check for Scala3 classes (default is true).

    Sets whether we check for Scala3 classes (default is true). Setting this to false can improve performance.

    support

    whether we check for Scala3 classes

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Since

    2.14.0

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. def version(): Version

    Permalink
    Definition Classes
    JacksonModule → Module → Versioned
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def setDescriptorCache(cache: LookupCache[String, BeanDescriptor]): LookupCache[String, BeanDescriptor]

    Permalink

    Replace the descriptorCache

    Replace the descriptorCache

    cache

    new cache instance

    returns

    the existing cache instance

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Annotations
    @deprecated
    Deprecated

    (Since version 2.14.3) key type will change to String in v2.15.0 and this function will be removed in a later release

    See also

    setLookupCacheFactory

    setDescriptorCacheSize

  2. def setScalaTypeCache(cache: LookupCache[String, Boolean]): LookupCache[String, Boolean]

    Permalink

    Override the default scalaTypeCache.

    Override the default scalaTypeCache.

    cache

    new cache instance

    returns

    existing cache instance

    Definition Classes
    ScalaAnnotationIntrospectorModule
    Annotations
    @deprecated
    Deprecated

    (Since version 2.14.3) key type will change to String in v2.15.0 and this function will be removed in a later release

    Since

    2.14.0

    See also

    setLookupCacheFactory

    setScalaTypeCacheSize

Inherited from DefaultScalaModule

Inherited from SymbolModule

Inherited from SymbolDeserializerModule

Inherited from SymbolSerializerModule

Inherited from EitherModule

Inherited from EitherSerializerModule

Inherited from EitherTypeModifierModule

Inherited from EitherDeserializerModule

Inherited from SetModule

Inherited from MapModule

Inherited from MapSerializerModule

Inherited from MapTypeModifierModule

Inherited from TupleModule

Inherited from TupleDeserializerModule

Inherited from TupleSerializerModule

Inherited from IterableModule

Inherited from SeqModule

Inherited from SeqDeserializerModule

Inherited from IterableSerializerModule

Inherited from OptionModule

Inherited from OptionDeserializerModule

Inherited from OptionSerializerModule

Inherited from OptionTypeModifierModule

Inherited from EnumerationModule

Inherited from IteratorModule

Inherited from IteratorSerializerModule

Inherited from ScalaTypeModifierModule

Inherited from JacksonModule

Inherited from Module

Inherited from Versioned

Inherited from AnyRef

Inherited from Any

Ungrouped