jackson-module-scala/com.fasterxml.jackson.module.scala.introspect/ScalaAnnotationIntrospectorModule

ScalaAnnotationIntrospectorModule

trait ScalaAnnotationIntrospectorModule extends JacksonModule
Companion:
object
class Module
trait Versioned
class Object
trait Matchable
class Any
object DefaultScalaModule.type

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

See also:
Since:

2.13.1

def clearRegisteredReferencedTypes(): Unit

Clears all the state associated with reference types

Clears all the state associated with reference types

See also:
Since:

2.13.1

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

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

See also:
Since:

2.13.1

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

See also:
Since:

2.14.3

def setLookupCacheFactory(lookupCacheFactory: LookupCacheFactory): Unit

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

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.

Value parameters:
lookupCacheFactory

new factory

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

See also:
Since:

2.14.3

def shouldSupportScala3Classes(): Boolean

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

Since:

2.14.0

def supportScala3Classes(support: Boolean): Unit

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

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

Value parameters:
support

whether we check for Scala3 classes

Since:

2.14.0

Deprecated methods

def setDescriptorCache(cache: LookupCache[ClassKey, BeanDescriptor]): LookupCache[ClassKey, BeanDescriptor]

Replace the descriptorCache</code.

Replace the descriptorCache</code.

Value parameters:
cache

new cache instance

Returns:

the existing cache instance

See also:
Deprecated

key type will change to String in v2.15.0 and this function will be removed in a later release

def setScalaTypeCache(cache: LookupCache[ClassKey, Boolean]): LookupCache[ClassKey, Boolean]

Override the default scalaTypeCache.

Override the default scalaTypeCache.

Value parameters:
cache

new cache instance

Returns:

existing cache instance

See also:
Since:

2.14.0

Deprecated

key type will change to String in v2.15.0 and this function will be removed in a later release

Inherited methods

def getDependencies(): Iterable[_ <: Module]
Inherited from:
Module
def getModuleName: String
Inherited from:
JacksonModule
def getTypeId(): <FromJavaObject>
Inherited from:
Module
def setupModule(context: SetupContext): Unit
Inherited from:
JacksonModule
override def version(): Version
Definition Classes
Inherited from:
JacksonModule