org.codehaus.jackson.map.jsontype
Interface TypeIdResolver

All Known Implementing Classes:
ClassNameIdResolver, MinimalClassNameIdResolver, TypeIdResolverBase, TypeNameIdResolver

public interface TypeIdResolver

Interface that defines standard API for converting types to type identifiers and vice versa. Used by type resolvers (TypeSerializer, TypeDeserializer) for converting between type and matching id; id is stored in JSON and needed for creating instances of proper subtypes when deserializing values.

Since:
1.5
Author:
tatu

Method Summary
 JsonTypeInfo.Id getMechanism()
          Accessor for mechanism that this resolver uses for determining type id from type.
 String idFromValue(Object value)
          Method called to serialize type of the type of given value as a String to include in serialized JSON content.
 void init(JavaType baseType)
          Method that will be called once before any type resolution calls; used to initialize instance with configuration.
 JavaType typeFromId(String id)
          Method called to resolve type from given type identifier.
 

Method Detail

init

void init(JavaType baseType)
Method that will be called once before any type resolution calls; used to initialize instance with configuration. This is necessary since instances may be created via reflection, without ability to call specific constructor to pass in configuration settings.

Parameters:
baseType - Base type for which this id resolver instance is used

idFromValue

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


typeFromId

JavaType typeFromId(String id)
Method called to resolve type from given type identifier.


getMechanism

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