Module tools.jackson.databind

Package tools.jackson.databind.jsontype.impl

Class TypeNameIdResolver

java.lang.Object

tools.jackson.databind.jsontype.impl.TypeIdResolverBase

tools.jackson.databind.jsontype.impl.TypeNameIdResolver

All Implemented Interfaces:

Serializable, TypeIdResolver

public class TypeNameIdResolver
extends TypeIdResolverBase
implements Serializable

TypeIdResolver implementation that converts using explicitly (annotation-) specified type names and maps to implementation classes; or, in absence of annotated type name, defaults to fully-qualified Class names (obtained with Class.getName()

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	_caseInsensitive
protected final Map<String,JavaType>	_idToType	Mappings from type id to JavaType, used for deserialization.
protected final ConcurrentHashMap<String,String>	_typeToId	Mappings from class name to type id, used for serialization.

Fields inherited from class tools.jackson.databind.jsontype.impl.TypeIdResolverBase

_baseType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeNameIdResolver(JavaType baseType, ConcurrentHashMap<String,String> typeToId, HashMap<String,JavaType> idToType, boolean caseInsensitive)

Method Summary

Modifier and Type	Method	Description
protected static String	_defaultTypeId(Class<?> cls)	If no name was explicitly given for a class, we will just use non-qualified class name
protected JavaType	_typeFromId(String id)
static TypeNameIdResolver	construct(MapperConfig<?> config, JavaType baseType, Collection<NamedType> subtypes, boolean forSer, boolean forDeser)
String	getDescForKnownTypeIds()	Helper method used to get a simple description of all known type ids, for use in error messages.
JsonTypeInfo.Id	getMechanism()	Accessor for mechanism that this resolver uses for determining type id from type.
protected String	idFromClass(DatabindContext ctxt, Class<?> cls)
String	idFromValue(DatabindContext ctxt, Object value)	Method called to serialize type of the type of given value as a String to include in serialized JSON content.
String	idFromValueAndType(DatabindContext ctxt, Object value, Class<?> type)	Alternative method used for determining type from combination of value and type, using suggested type (that serializer provides) and possibly value of that type.
JavaType	typeFromId(DatabindContext context, String id)	Method called to resolve type from given type identifier.

Methods inherited from class tools.jackson.databind.jsontype.impl.TypeIdResolverBase

_resolveToParentAsNecessary, idFromBaseType, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_typeToId

protected final ConcurrentHashMap<String,String> _typeToId

Mappings from class name to type id, used for serialization.

Since lazily constructed will require synchronization (either internal by type, or external)

_idToType

protected final Map<String,JavaType> _idToType

Mappings from type id to JavaType, used for deserialization.

Eagerly constructed, not modified, can use regular unsynchronized Map.

_caseInsensitive

protected final boolean _caseInsensitive

Constructor Details

TypeNameIdResolver

protected TypeNameIdResolver(JavaType baseType,
 ConcurrentHashMap<String,String> typeToId,
 HashMap<String,JavaType> idToType,
 boolean caseInsensitive)

Method Details

construct

public static TypeNameIdResolver construct(MapperConfig<?> config,
 JavaType baseType,
 Collection<NamedType> subtypes,
 boolean forSer,
 boolean forDeser)

getMechanism

public JsonTypeInfo.Id getMechanism()

Description copied from interface: TypeIdResolver

Accessor for mechanism that this resolver uses for determining type id from type. Mostly informational; not required to be called or used.

Specified by:

getMechanism in interface TypeIdResolver

idFromValue

public String idFromValue(DatabindContext ctxt,
 Object value)

Description copied from interface: TypeIdResolver

Method called to serialize type of the type of given value as a String to include in serialized JSON content.

Specified by:

idFromValue in interface TypeIdResolver

idFromClass

protected String idFromClass(DatabindContext ctxt,
 Class<?> cls)

idFromValueAndType

public String idFromValueAndType(DatabindContext ctxt,
 Object value,
 Class<?> type)

Description copied from interface: TypeIdResolver

Alternative method used for determining type from combination of value and type, using suggested type (that serializer provides) and possibly value of that type. Most common implementation will use suggested type as is.

Specified by:

idFromValueAndType in interface TypeIdResolver

typeFromId

public JavaType typeFromId(DatabindContext context,
 String id)

Description copied from interface: TypeIdResolver

Method called to resolve type from given type identifier.

Specified by:

typeFromId in interface TypeIdResolver

Overrides:

typeFromId in class TypeIdResolverBase

_typeFromId

protected JavaType _typeFromId(String id)

getDescForKnownTypeIds

public String getDescForKnownTypeIds()

Description copied from class: TypeIdResolverBase

Helper method used to get a simple description of all known type ids, for use in error messages.

Specified by:

getDescForKnownTypeIds in interface TypeIdResolver

Overrides:

getDescForKnownTypeIds in class TypeIdResolverBase

_defaultTypeId

protected static String _defaultTypeId(Class<?> cls)

If no name was explicitly given for a class, we will just use non-qualified class name