Interface TypeResolverBuilder<T extends TypeResolverBuilder<T>>
-
- All Known Implementing Classes:
ObjectMapper.DefaultTypeResolverBuilder
,StdTypeResolverBuilder
public interface TypeResolverBuilder<T extends TypeResolverBuilder<T>>
Interface that defines builders that are configured based on annotations (likeJsonTypeInfo
or JAXB annotations), and produce type serializers and deserializers used for handling type information embedded in JSON to allow for safe polymorphic type handling.Builder is first initialized by calling
init(com.fasterxml.jackson.annotation.JsonTypeInfo.Id, com.fasterxml.jackson.databind.jsontype.TypeIdResolver)
method, and then configured using 'set' methods likeinclusion(com.fasterxml.jackson.annotation.JsonTypeInfo.As)
. Finally, after calling all configuration methods,buildTypeSerializer(com.fasterxml.jackson.databind.SerializationConfig, com.fasterxml.jackson.databind.JavaType, java.util.Collection<com.fasterxml.jackson.databind.jsontype.NamedType>)
orbuildTypeDeserializer(com.fasterxml.jackson.databind.DeserializationConfig, com.fasterxml.jackson.databind.JavaType, java.util.Collection<com.fasterxml.jackson.databind.jsontype.NamedType>)
will be called to get actual type resolver constructed and used for resolving types for configured base type and its subtypes.Note that instances are used for two related but distinct use cases:
- To create builders to use with explicit type information
inclusion (usually via
@JsonTypeInfo
annotation) - To create builders when "default typing" is used; if so, type information is automatically included for certain kind of types, regardless of annotations
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TypeDeserializer
buildTypeDeserializer(DeserializationConfig config, JavaType baseType, Collection<NamedType> subtypes)
Method for building type deserializer based on current configuration of this builder.TypeSerializer
buildTypeSerializer(SerializationConfig config, JavaType baseType, Collection<NamedType> subtypes)
Method for building type serializer based on current configuration of this builder.T
defaultImpl(Class<?> defaultImpl)
Method for specifying default implementation to use if type id is either not available, or cannot be resolved.Class<?>
getDefaultImpl()
Accessor for currently configured default type; implementation class that may be used in case no valid type information is available during type resolutionT
inclusion(JsonTypeInfo.As includeAs)
Method for specifying mechanism to use for including type metadata in JSON.T
init(JsonTypeInfo.Id idType, TypeIdResolver res)
Initialization method that is called right after constructing the builder instance.T
typeIdVisibility(boolean isVisible)
Method for specifying whether type id should be visible toJsonDeserializer
s or not.T
typeProperty(String propName)
Method for specifying name of property used for including type information.default T
withDefaultImpl(Class<?> defaultImpl)
"Mutant factory" method for creating a new instance with different default implementation.
-
-
-
Method Detail
-
getDefaultImpl
Class<?> getDefaultImpl()
Accessor for currently configured default type; implementation class that may be used in case no valid type information is available during type resolution
-
buildTypeSerializer
TypeSerializer buildTypeSerializer(SerializationConfig config, JavaType baseType, Collection<NamedType> subtypes)
Method for building type serializer based on current configuration of this builder.- Parameters:
baseType
- Base type that constructed resolver will handle; super type of all types it will be used for.
-
buildTypeDeserializer
TypeDeserializer buildTypeDeserializer(DeserializationConfig config, JavaType baseType, Collection<NamedType> subtypes)
Method for building type deserializer based on current configuration of this builder.- Parameters:
baseType
- Base type that constructed resolver will handle; super type of all types it will be used for.subtypes
- Known subtypes of the base type.
-
init
T init(JsonTypeInfo.Id idType, TypeIdResolver res)
Initialization method that is called right after constructing the builder instance.- Parameters:
idType
- Which type metadata is usedres
- (optional) Custom type id resolver used, if any- Returns:
- Resulting builder instance (usually this builder, but not necessarily)
-
inclusion
T inclusion(JsonTypeInfo.As includeAs)
Method for specifying mechanism to use for including type metadata in JSON. If not explicitly called, setting defaults toJsonTypeInfo.As.PROPERTY
.- Parameters:
includeAs
- Mechanism used for including type metadata in JSON- Returns:
- Resulting builder instance (usually this builder, but may be a newly constructed instance for immutable builders}
-
typeProperty
T typeProperty(String propName)
Method for specifying name of property used for including type information. Not used for all inclusion mechanisms; usually only used withJsonTypeInfo.As.PROPERTY
.If not explicitly called, name of property to use is based on defaults for
JsonTypeInfo.Id
configured.- Parameters:
propName
- Name of JSON property to use for including type information- Returns:
- Resulting builder instance (usually this builder, but may be a newly constructed instance for immutable builders}
-
defaultImpl
T defaultImpl(Class<?> defaultImpl)
Method for specifying default implementation to use if type id is either not available, or cannot be resolved.- Returns:
- Resulting builder instance (usually this builder, but may be a newly constructed instance for immutable builders}
-
typeIdVisibility
T typeIdVisibility(boolean isVisible)
Method for specifying whether type id should be visible toJsonDeserializer
s or not.- Returns:
- Resulting builder instance (usually this builder, but may be a newly constructed instance for immutable builders}
- Since:
- 2.0
-
-