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

ScalaAnnotationIntrospectorModule

object ScalaAnnotationIntrospectorModule extends ScalaAnnotationIntrospectorModule
Companion:
class
class Module
trait Versioned
class Object
trait Matchable
class Any

Value members

Inherited methods

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

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

Value parameters:
clazz

the class for which to remove the registered reference types

See also:
Since:

2.13.1

Inherited from:
ScalaAnnotationIntrospectorModule
def getDependencies(): Iterable[_ <: Module]
Inherited from:
Module
def getModuleName: String
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.

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

Inherited from:
ScalaAnnotationIntrospectorModule
def getTypeId(): <FromJavaObject>
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.

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

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

Override the default scalaTypeCache.

Override the default scalaTypeCache.

Value parameters:
cache

new cache instance

Returns:

old cache instance

Since:

2.14.0

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

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.

Value parameters:
support

whether we check for Scala3 classes

Since:

2.14.0

Inherited from:
ScalaAnnotationIntrospectorModule
override def version(): Version
Definition Classes
Inherited from:
JacksonModule