jackson-module-scala
API
Generated with
jackson-module-scala/com.fasterxml.jackson.module.scala.introspect/ScalaAnnotationIntrospectorModule

ScalaAnnotationIntrospectorModule

com.fasterxml.jackson.module.scala.introspect.ScalaAnnotationIntrospectorModule$
See theScalaAnnotationIntrospectorModule companion trait
object ScalaAnnotationIntrospectorModule extends ScalaAnnotationIntrospectorModule

Attributes

Companion:
trait
Graph
Supertypes
class Module
trait Versioned
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Inherited methods

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.1

Inherited from:
ScalaAnnotationIntrospectorModule
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

Attributes

clazz

the class for which to remove the registered reference types

See also:
Since:

2.13.1

Inherited from:
ScalaAnnotationIntrospectorModule
def getDependencies(): Iterable[_ <: Module]

Attributes

Inherited from:
Module
override def getModuleName: String

Attributes

Definition Classes
Inherited from:
JacksonModule
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.

Attributes

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

Inherited from:
ScalaAnnotationIntrospectorModule
def getTypeId(): <FromJavaObject>

Attributes

Inherited from:
Module
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.

Attributes

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

Inherited from:
ScalaAnnotationIntrospectorModule
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.

Attributes

size

new size for the cache

See also:
Since:

2.14.3

Inherited from:
ScalaAnnotationIntrospectorModule
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.

Attributes

lookupCacheFactory

new factory

See also:
Since:

2.14.3

Inherited from:
ScalaAnnotationIntrospectorModule
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.

Attributes

size

new size for the cache

See also:
Since:

2.14.3

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

Attributes

Inherited from:
JacksonModule
def shouldSupportScala3Classes(): Boolean

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

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

Attributes

Returns:

whether we check for Scala3 classes

Since:

2.14.0

Inherited from:
ScalaAnnotationIntrospectorModule
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.

Attributes

support

whether we check for Scala3 classes

Since:

2.14.0

Inherited from:
ScalaAnnotationIntrospectorModule
override def version(): Version

Attributes

Definition Classes
Inherited from:
JacksonModule

Deprecated and Inherited methods

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

Replace the descriptorCache</code.

Replace the descriptorCache</code.

Attributes

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

Inherited from:
ScalaAnnotationIntrospectorModule
def setScalaTypeCache(cache: LookupCache[String, Boolean]): LookupCache[String, Boolean]

Override the default scalaTypeCache.

Override the default scalaTypeCache.

Attributes

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 from:
ScalaAnnotationIntrospectorModule
Generated with