jackson-module-scala/com.fasterxml.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: trait ScalaAnnotationIntrospectorModule

trait JacksonModule

class Module

trait Versioned

class Object

trait Matchable

class Any
Show all
Self type: ScalaAnnotationIntrospectorModule.type

Members list

Value members

Inherited methods

Clears all the state associated with reference types

Attributes

See also: registerReferencedValueType

clearRegisteredReferencedTypes
Since: 2.13.1
Inherited from:: ScalaAnnotationIntrospectorModule

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: registerReferencedValueType

clearRegisteredReferencedTypes
Since: 2.13.1
Inherited from:: ScalaAnnotationIntrospectorModule

Attributes

Inherited from:: Module

Attributes

Definition Classes: JacksonModule -> Module
Inherited from:: JacksonModule

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

Attributes

Inherited from:: Module

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: getRegisteredReferencedValueType

clearRegisteredReferencedTypes

clearRegisteredReferencedTypes
Since: 2.13.1
Inherited from:: ScalaAnnotationIntrospectorModule

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: setScalaTypeCacheSize

setLookupCacheFactory
Since: 2.14.3
Inherited from:: ScalaAnnotationIntrospectorModule

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

Attributes

See also: setDescriptorCacheSize

setScalaTypeCacheSize
Since: 2.14.3
Inherited from:: ScalaAnnotationIntrospectorModule

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: setDescriptorCacheSize

setLookupCacheFactory
Since: 2.14.3
Inherited from:: ScalaAnnotationIntrospectorModule

Attributes

Inherited from:: JacksonModule

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

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

Attributes

Since: 2.14.0
Inherited from:: ScalaAnnotationIntrospectorModule

Attributes

Definition Classes: JacksonModule -> Module -> Versioned
Inherited from:: JacksonModule

Deprecated and Inherited methods

Replace the descriptorCache</code.

Replace the descriptorCache</code.

`Value parameters`

cache: new cache instance

`Attributes`

Returns: the existing cache instance
See also: setDescriptorCacheSize

setLookupCacheFactory
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.
               
               Value parameters
               
                
                 cache
                
                
                 new cache instance
                
               
               Attributes
               
                
                 Returns
                
                
                 existing cache instance
                
                
                 See also
                
                
                 
                  
                   setScalaTypeCacheSize
                  
                  
                   setLookupCacheFactory
                  
                 
                
                
                 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

In this article

Generated with