jackson-module-scala
API
Generated with
jackson-module-scala/tools.jackson.module.scala/tools.jackson.module.scala.introspect/ScalaAnnotationIntrospectorModule

ScalaAnnotationIntrospectorModule

tools.jackson.module.scala.introspect.ScalaAnnotationIntrospectorModule
See theScalaAnnotationIntrospectorModule companion object
trait ScalaAnnotationIntrospectorModule extends JacksonModule

Attributes

Companion
object
Graph
Supertypes
trait Versioned
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Concrete methods

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

clears the state associated with reference types for the given class

clears the state associated with reference types for the given class

Value parameters

clazz

the class for which to remove the registered reference types

Attributes

See also
Since

2.13.0

def clearRegisteredReferencedTypes(): Unit

Clears all the state associated with reference types

Clears all the state associated with reference types

Attributes

See also
Since

2.13.0

override def getInitializers(config: Config): Seq[SetupContext => Unit]

Attributes

Definition Classes
override def getModuleName: String

Attributes

Definition Classes
def getRegisteredReferencedValueType(clazz: Class[_], fieldName: String): Option[Class[_]]

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.

Value parameters

clazz

the (case) class

fieldName

the field name in the (case) class

Attributes

Returns

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

See also
Since

2.13.1

def registerReferencedValueType(clazz: Class[_], fieldName: String, referencedType: Class[_]): Unit

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.

Value parameters

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

Attributes

See also
Since

2.13.0

def setDescriptorCacheSize(size: Int): Unit

Resize the descriptorCache. The default size is 100.

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.

Value parameters

size

new size for the cache

Attributes

See also
Since

2.14.3

def setLookupCacheFactory(lookupCacheFactory: LookupCacheFactory): Unit

Replaces the LookupCacheFactory. The default factory uses tools.jackson.databind.util.SimpleLookupCache.

Replaces the LookupCacheFactory. The default factory uses tools.jackson.databind.util.SimpleLookupCache.

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.

Value parameters

lookupCacheFactory

new factory

Attributes

See also
Since

2.14.3

def setScalaTypeCacheSize(size: Int): Unit

Resize the scalaTypeCache. The default size is 1000.

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.

Value parameters

size

new size for the cache

Attributes

See also
Since

2.14.3

Inherited methods

def getDependencies(): Iterable[_ <: JacksonModule]

Attributes

Inherited from:
JacksonModule
def getRegistrationId(): <FromJavaObject>

Attributes

Inherited from:
JacksonModule
def setupModule(context: SetupContext): Unit

Attributes

Inherited from:
JacksonModule
override def version(): Version

Attributes

Definition Classes
Inherited from:
JacksonModule
Generated with