Module tools.jackson.databind

Package tools.jackson.databind.jsontype.impl

Class ClassNameIdResolver

java.lang.Object

tools.jackson.databind.jsontype.impl.TypeIdResolverBase

tools.jackson.databind.jsontype.impl.ClassNameIdResolver

All Implemented Interfaces:

Serializable, TypeIdResolver

Direct Known Subclasses:

MinimalClassNameIdResolver

public class ClassNameIdResolver
extends TypeIdResolverBase
implements Serializable

TypeIdResolver implementation that converts between fully-qualified Java class names and (JSON) Strings.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<String>	_allowedSubtypes	To support DeserializationFeature.FAIL_ON_SUBTYPE_CLASS_NOT_REGISTERED)
protected final PolymorphicTypeValidator	_subTypeValidator

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

_baseType

Constructor Summary

Constructors

Constructor	Description
ClassNameIdResolver(JavaType baseType, Collection<NamedType> subtypes, PolymorphicTypeValidator ptv)

Method Summary

Modifier and Type	Method	Description
protected String	_idFrom(DatabindContext ctxt, Object value, Class<?> cls)
protected JavaType	_typeFromId(DatabindContext ctxt, String id)
static ClassNameIdResolver	construct(JavaType baseType, Collection<NamedType> subtypes, PolymorphicTypeValidator ptv)
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.
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 ctxt, 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

_subTypeValidator

protected final PolymorphicTypeValidator _subTypeValidator

_allowedSubtypes

protected final Set<String> _allowedSubtypes

To support DeserializationFeature.FAIL_ON_SUBTYPE_CLASS_NOT_REGISTERED)

Constructor Details

ClassNameIdResolver

public ClassNameIdResolver(JavaType baseType,
 Collection<NamedType> subtypes,
 PolymorphicTypeValidator ptv)

Method Details

construct

public static ClassNameIdResolver construct(JavaType baseType,
 Collection<NamedType> subtypes,
 PolymorphicTypeValidator ptv)

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

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 ctxt,
 String id)
                    throws JacksonException

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

Throws:

JacksonException

_typeFromId

protected JavaType _typeFromId(DatabindContext ctxt,
 String id)
                        throws JacksonException

Throws:

JacksonException

_idFrom

protected String _idFrom(DatabindContext ctxt,
 Object value,
 Class<?> cls)

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