Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	AndroidRecordModule.AndroidRecordAnnotationIntrospector
pack-priv static class	AndroidRecordModule.AndroidRecordClassIntrospector
pack-priv static class	AndroidRecordModule.AndroidRecordNaming

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.module.SimpleModule.serialVersionUID.

Access	Constructor and Description
public	AndroidRecordModule()

Method Summary

Modifier and Type	Method and Description
pack-priv static Class<?>	arrayTypeCompat(Class<?> componentType)
pack-priv static Type	fixAndroidGenericType(Type type)
pack-priv static Stream<Field>	getDesugaredRecordComponents(Class<?> raw)
pack-priv static boolean	isDesugaredRecordClass(Class<?> raw)
public void	setupModule(JacksonModule.SetupContext context) Overrides tools.jackson.databind.module.SimpleModule.setupModule. Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.module.SimpleModule.serialVersionUID.

AndroidRecordModule	back to summary
public AndroidRecordModule()

Method Detail

arrayTypeCompat	back to summary
pack-priv static Class<?> arrayTypeCompat(Class<?> componentType)

fixAndroidGenericType	back to summary
pack-priv static Type fixAndroidGenericType(Type type)

getDesugaredRecordComponents	back to summary
pack-priv static Stream<Field> getDesugaredRecordComponents(Class<?> raw)

isDesugaredRecordClass	back to summary
pack-priv static boolean isDesugaredRecordClass(Class<?> raw)

setupModule	back to summary
public void setupModule(JacksonModule.SetupContext context) Overrides tools.jackson.databind.module.SimpleModule.setupModule. Doc from tools.jackson.databind.module.SimpleModule.setupModule. Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered. Annotations @Override

setupModule

back to summary

public void setupModule(JacksonModule.SetupContext context)

Overrides tools.jackson.databind.module.SimpleModule.setupModule.

Doc from tools.jackson.databind.module.SimpleModule.setupModule.

Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered.

Annotations

@Override

tools.jackson.module.androidrecord back to summary

pack-priv Class AndroidRecordModule.AndroidRecordAnnotationIntrospector

Class Inheritance

extends AnnotationIntrospector

java.lang.Object
tools.jackson.databind.AnnotationIntrospector
tools.jackson.module.androidrecord.AndroidRecordModule.AndroidRecordAnnotationIntrospector

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	AndroidRecordAnnotationIntrospector()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public PotentialCreator	findPreferredCreator(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories, Optional<PotentialCreator> zeroParamsConstructor) Overrides tools.jackson.databind.AnnotationIntrospector.findPreferredCreator. Method called to check if introspector can find a Creator it considers its "Preferred Creator": Creator to use as the primary one, when no Creator has explicit annotation (`findCreatorAnnotation` returns `null`).
public Version	version() Implements abstract tools.jackson.databind.AnnotationIntrospector.version. Implements tools.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details).

public PotentialCreator

findPreferredCreator(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories, Optional<PotentialCreator> zeroParamsConstructor)

Overrides tools.jackson.databind.AnnotationIntrospector.findPreferredCreator.

public Version

version()

Implements abstract tools.jackson.databind.AnnotationIntrospector.version.

Implements tools.jackson.core.Versioned.version.

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Inherited from tools.jackson.databind.AnnotationIntrospector:: _findAnnotation _hasAnnotation _hasOneOf allIntrospectors allIntrospectors findAndAddVirtualProperties findAutoDetectVisibility findClassDescription findContentDeserializer findContentSerializer findCreatorAnnotation findDefaultEnumValue findDeserializationContentConverter findDeserializationConverter findDeserializer findEnumAliases findEnumNamingStrategy findEnumValues findFilterId findFormat findImplicitPropertyName findInjectableValue findKeyDeserializer findKeySerializer findMergeInfo findNameForDeserialization findNameForSerialization findNamingStrategy findNullSerializer findObjectIdInfo findObjectReferenceInfo findPOJOBuilder findPOJOBuilderConfig findPolymorphicTypeInfo findPropertyAccess findPropertyAliases findPropertyDefaultValue findPropertyDescription findPropertyIgnoralByName findPropertyInclusion findPropertyInclusionByName findPropertyIndex findReferenceType findRenameByField findRootName findSerializationContentConverter findSerializationConverter findSerializationPropertyOrder findSerializationSortAlphabetically findSerializationTyping findSerializer findSetterInfo findSubtypes findTypeIdResolver findTypeName findTypeResolverBuilder findUnwrappingNameTransformer findValueInstantiator findViews findWrapperName hasAnyGetter hasAnySetter hasAsKey hasAsValue hasIgnoreMarker hasRequiredMarker isAnnotationBundle isIgnorableType isTypeId nopInstance pair refineDeserializationType refineSerializationType resolveSetterConflict

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AndroidRecordAnnotationIntrospector	back to summary
pack-priv AndroidRecordAnnotationIntrospector()

Method Detail

findPreferredCreator back to summary

findPreferredCreator	back to summary
public PotentialCreator findPreferredCreator(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories, Optional<PotentialCreator> zeroParamsConstructor) Overrides tools.jackson.databind.AnnotationIntrospector.findPreferredCreator. Doc from tools.jackson.databind.AnnotationIntrospector.findPreferredCreator. Method called to check if introspector can find a Creator it considers its "Preferred Creator": Creator to use as the primary one, when no Creator has explicit annotation (`findCreatorAnnotation` returns `null`). Examples of preferred creators include the canonical constructor defined by Java Records; "Data" classes by frameworks like Lombok and JVM languages like Kotlin and Scala (case classes) also have similar concepts. If introspector can determine that one of given `PotentialCreator`s should be considered preferred one, it should return it; if not, it should return `null`. Note that core databind functionality may call this method even in the presence of explicitly annotated creators; and may or may not use Creator returned depending on other criteria. Note when returning chosen Creator, it may be necessary to mark its "mode" with `PotentialCreator#overrideMode` (especially for "delegating" creators). Note method is NOT called for Java Record types; selection of the canonical constructor as the Primary creator is handled directly by `POJOPropertiesCollector` Note was called `findDefaultCreator()` in Jackson 2.x but was renamed due to possible confusion with 0-argument "default" constructor. Annotations @Override

public PotentialCreator findPreferredCreator(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories, Optional<PotentialCreator> zeroParamsConstructor)

Overrides tools.jackson.databind.AnnotationIntrospector.findPreferredCreator.

Doc from tools.jackson.databind.AnnotationIntrospector.findPreferredCreator.

Method called to check if introspector can find a Creator it considers its "Preferred Creator": Creator to use as the primary one, when no Creator has explicit annotation (findCreatorAnnotation returns null). Examples of preferred creators include the canonical constructor defined by Java Records; "Data" classes by frameworks like Lombok and JVM languages like Kotlin and Scala (case classes) also have similar concepts. If introspector can determine that one of given PotentialCreators should be considered preferred one, it should return it; if not, it should return null. Note that core databind functionality may call this method even in the presence of explicitly annotated creators; and may or may not use Creator returned depending on other criteria.

Note

when returning chosen Creator, it may be necessary to mark its "mode" with PotentialCreator#overrideMode (especially for "delegating" creators).

Note

method is NOT called for Java Record types; selection of the canonical constructor as the Primary creator is handled directly by POJOPropertiesCollector

Note

was called findDefaultCreator() in Jackson 2.x but was renamed due to possible confusion with 0-argument "default" constructor.

Annotations

@Override

version back to summary

version	back to summary
public Version version() Implements abstract tools.jackson.databind.AnnotationIntrospector.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details). Annotations @Override

public Version version()

Implements abstract tools.jackson.databind.AnnotationIntrospector.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.core.Versioned.version.

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Annotations

@Override

tools.jackson.module.androidrecord back to summary

pack-priv Class AndroidRecordModule.AndroidRecordClassIntrospector

Class Inheritance

extends BasicClassIntrospector

java.lang.Object
tools.jackson.databind.introspect.ClassIntrospector
tools.jackson.databind.introspect.BasicClassIntrospector
tools.jackson.module.androidrecord.AndroidRecordModule.AndroidRecordClassIntrospector

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.introspect.BasicClassIntrospector.serialVersionUID.

Inherited from tools.jackson.databind.introspect.BasicClassIntrospector:: _config _mixInResolver _resolvedDeserBeanDescs _resolvedFullAnnotations _resolvedSerBeanDescs

Constructor Summary

Access	Constructor and Description
public	AndroidRecordClassIntrospector()
pack-priv	AndroidRecordClassIntrospector(MapperConfig<?> config)

Method Summary

Modifier and Type	Method and Description
protected POJOPropertiesCollector	collectProperties(JavaType type, AnnotatedClass classDef, boolean forSerialization, String mutatorPrefix) Overrides tools.jackson.databind.introspect.BasicClassIntrospector.collectProperties.
public BasicClassIntrospector	forMapper() Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forMapper. Method called to create an instance to be exclusive used by specified mapper.
public BasicClassIntrospector	forOperation(MapperConfig<?> config) Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forOperation. Method called to further create an instance to be used for a single operation (read or write, typically matching `ObjectMapper` `readValue()` or `writeValue()`).

Inherited from tools.jackson.databind.introspect.BasicClassIntrospector:: _findStdJdkCollectionDesc _findStdTypeDef _findStdTypeDesc _resolveAnnotatedClass _resolveAnnotatedWithoutSuperTypes collectPropertiesWithBuilder constructPropertyCollector introspectClassAnnotations introspectDirectClassAnnotations introspectForCreation introspectForDeserialization introspectForDeserializationWithBuilder introspectForSerialization

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.introspect.BasicClassIntrospector.serialVersionUID.

Constructor Detail

AndroidRecordClassIntrospector	back to summary
public AndroidRecordClassIntrospector()

AndroidRecordClassIntrospector	back to summary
pack-priv AndroidRecordClassIntrospector(MapperConfig<?> config)

Method Detail

collectProperties	back to summary
protected POJOPropertiesCollector collectProperties(JavaType type, AnnotatedClass classDef, boolean forSerialization, String mutatorPrefix) Overrides tools.jackson.databind.introspect.BasicClassIntrospector.collectProperties. Annotations @Override

collectProperties

back to summary

protected POJOPropertiesCollector collectProperties(JavaType type, AnnotatedClass classDef, boolean forSerialization, String mutatorPrefix)

Overrides tools.jackson.databind.introspect.BasicClassIntrospector.collectProperties.

Annotations

@Override

forMapper	back to summary
public BasicClassIntrospector forMapper() Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forMapper. Doc from tools.jackson.databind.introspect.ClassIntrospector.forMapper. Method called to create an instance to be exclusive used by specified mapper. Needed to ensure that no sharing through cache occurs. Basic implementation just returns instance itself. Annotations @Override

forMapper

back to summary

public BasicClassIntrospector forMapper()

Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forMapper.

Doc from tools.jackson.databind.introspect.ClassIntrospector.forMapper.

Method called to create an instance to be exclusive used by specified mapper. Needed to ensure that no sharing through cache occurs.

Basic implementation just returns instance itself.

Annotations

@Override

forOperation back to summary

forOperation	back to summary
public BasicClassIntrospector forOperation(MapperConfig<?> config) Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forOperation. Doc from tools.jackson.databind.introspect.ClassIntrospector.forOperation. Method called to further create an instance to be used for a single operation (read or write, typically matching `ObjectMapper` `readValue()` or `writeValue()`). Annotations @Override

public BasicClassIntrospector forOperation(MapperConfig<?> config)

Overrides tools.jackson.databind.introspect.BasicClassIntrospector.forOperation.

Doc from tools.jackson.databind.introspect.ClassIntrospector.forOperation.

Method called to further create an instance to be used for a single operation (read or write, typically matching ObjectMapper readValue() or writeValue()).

Annotations

@Override

tools.jackson.module.androidrecord back to summary

pack-priv final Class AndroidRecordModule.AndroidRecordNaming

Class Inheritance

extends DefaultAccessorNamingStrategy

java.lang.Object
tools.jackson.databind.introspect.AccessorNamingStrategy
tools.jackson.databind.introspect.DefaultAccessorNamingStrategy
tools.jackson.module.androidrecord.AndroidRecordModule.AndroidRecordNaming

Field Summary

Modifier and Type	Field and Description
private final Set<String>	_componentNames Names of actual Record components from definition; auto-detected.

Inherited from tools.jackson.databind.introspect.DefaultAccessorNamingStrategy:: _baseNameValidator _config _forClass _getterPrefix _isGetterPrefix _isGettersNonBoolean _mutatorPrefix

Constructor Summary

Access	Constructor and Description
pack-priv	AndroidRecordNaming(MapperConfig<?> config, AnnotatedClass forClass)

Method Summary

Modifier and Type	Method and Description
public String	findNameForRegularGetter(AnnotatedMethod am, String name) Overrides tools.jackson.databind.introspect.DefaultAccessorNamingStrategy.findNameForRegularGetter. Method called to find whether given method would be considered a "regular" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property) Note that signature acceptability has already been checked (no arguments, does have a return value) by caller.

Modifier and Type

Method and Description

public String

findNameForRegularGetter(AnnotatedMethod am, String name)

Overrides tools.jackson.databind.introspect.DefaultAccessorNamingStrategy.findNameForRegularGetter.

Method called to find whether given method would be considered a "regular" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)

Note that signature acceptability has already been checked (no arguments, does have a return value) by caller.

Inherited from tools.jackson.databind.introspect.DefaultAccessorNamingStrategy:: _isCglibGetCallbacks _isGroovyMetaClassGetter findNameForIsGetter findNameForMutator modifyFieldName stdManglePropertyName

Field Detail

_componentNames	back to summary
private final Set<String> _componentNames Names of actual Record components from definition; auto-detected.

Constructor Detail

AndroidRecordNaming	back to summary
pack-priv AndroidRecordNaming(MapperConfig<?> config, AnnotatedClass forClass)

Method Detail

findNameForRegularGetter back to summary

findNameForRegularGetter	back to summary
public String findNameForRegularGetter(AnnotatedMethod am, String name) Overrides tools.jackson.databind.introspect.DefaultAccessorNamingStrategy.findNameForRegularGetter. Doc from tools.jackson.databind.introspect.AccessorNamingStrategy.findNameForRegularGetter. Method called to find whether given method would be considered a "regular" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property) Note that signature acceptability has already been checked (no arguments, does have a return value) by caller. Note that this method MAY be called for potential "is-getter" methods too (before `findNameForIsGetter`) Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect. Annotations @Override

public String findNameForRegularGetter(AnnotatedMethod am, String name)

Overrides tools.jackson.databind.introspect.DefaultAccessorNamingStrategy.findNameForRegularGetter.

Doc from tools.jackson.databind.introspect.AccessorNamingStrategy.findNameForRegularGetter.

Note that signature acceptability has already been checked (no arguments, does have a return value) by caller.

Note that this method MAY be called for potential "is-getter" methods too (before findNameForIsGetter)

Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.

Annotations

@Override

public Class AndroidRecordModule

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AndroidRecordModule.AndroidRecordAnnotationIntrospector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AndroidRecordModule.AndroidRecordClassIntrospector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class AndroidRecordModule.AndroidRecordNaming

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail