ScalaAnnotationIntrospectorModule

Value Members

final def !=(arg0: Any): Boolean

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

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

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

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

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

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

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

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

Definition Classes
Any
def clearRegisteredReferencedTypes(): Unit

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
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
clazz
the class for which to remove the registered reference types

Definition Classes
ScalaAnnotationIntrospectorModule
Since
2.13.1
See also
clearRegisteredReferencedTypes()
registerReferencedValueType
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

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

Definition Classes
Module
def getModuleName(): String

Definition Classes
JacksonModule → Module
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.
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
def getTypeId(): AnyRef

Definition Classes
Module
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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.
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
def setDescriptorCacheSize(size: Int): Unit

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
def setLookupCacheFactory(lookupCacheFactory: LookupCacheFactory): Unit

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
def setScalaTypeCacheSize(size: Int): Unit

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
def setupModule(context: SetupContext): Unit

Definition Classes
JacksonModule → Module
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

Definition Classes
ScalaAnnotationIntrospectorModule
Since
2.14.0
def supportScala3Classes(support: Boolean): Unit

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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def version(): Version

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

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

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 setLookupCacheFactorysetDescriptorCacheSize
def setScalaTypeCache(cache: LookupCache[String, Boolean]): LookupCache[String, Boolean] 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 setLookupCacheFactorysetScalaTypeCacheSize



        
        
              Inherited from ScalaAnnotationIntrospectorModule
            

              Inherited from JacksonModule
            

              Inherited from Module
            

              Inherited from Versioned
            

              Inherited from AnyRef
            

              Inherited from Any
            
        
        

        
        
              Ungrouped

Related Docs: trait ScalaAnnotationIntrospectorModule | package introspect

object ScalaAnnotationIntrospectorModule extends Module with ScalaAnnotationIntrospectorModule

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +=(beanSerMod: BeanSerializerModifier): ScalaAnnotationIntrospectorModule.this.type

def +=(typeMod: TypeModifier): ScalaAnnotationIntrospectorModule.this.type

def +=(deser: Deserializers): ScalaAnnotationIntrospectorModule.this.type

def +=(ser: Serializers): ScalaAnnotationIntrospectorModule.this.type

def +=(init: (SetupContext) ⇒ Unit): ScalaAnnotationIntrospectorModule.this.type

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clearRegisteredReferencedTypes(): Unit

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

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

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

def getModuleName(): String

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

def getTypeId(): AnyRef

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def setDescriptorCacheSize(size: Int): Unit

def setLookupCacheFactory(lookupCacheFactory: LookupCacheFactory): Unit

def setScalaTypeCacheSize(size: Int): Unit

def setupModule(context: SetupContext): Unit

def shouldSupportScala3Classes(): Boolean

def supportScala3Classes(support: Boolean): Unit

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

def toString(): String

def version(): Version

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

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

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

Inherited from ScalaAnnotationIntrospectorModule

Inherited from JacksonModule

Inherited from Module

Inherited from Versioned

Inherited from AnyRef

Inherited from Any

Ungrouped