com.fasterxml.jackson.databind.jsontype.impl

Class AsExternalTypeSerializer

java.lang.Object

com.fasterxml.jackson.databind.jsontype.TypeSerializer

com.fasterxml.jackson.databind.jsontype.impl.TypeSerializerBase

com.fasterxml.jackson.databind.jsontype.impl.AsExternalTypeSerializer

public class AsExternalTypeSerializer
extends TypeSerializerBase

Type serializer that preferably embeds type information as an "external" type property; embedded in enclosing JSON object. Note that this serializer should only be used when value is being output at JSON Object context; otherwise it cannot work reliably, and will have to revert operation similar to AsPropertyTypeSerializer.

Note that implementation of serialization is bit cumbersome as we must serialized external type id AFTER object; this because callback only occurs after field name has been written.

Also note that this type of type id inclusion will NOT try to make use of native Type Ids, even if those exist.

Constructor Summary

Constructors

Constructor and Description
AsExternalTypeSerializer(TypeIdResolver idRes, BeanProperty property, String propName)

Method Summary

Modifier and Type	Method and Description
AsExternalTypeSerializer	forProperty(BeanProperty prop) Method called to create contextual version, to be used for values of given property.
String	getPropertyName() Name of property that contains type information, if property-based inclusion is used.
JsonTypeInfo.As	getTypeInclusion() Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.

Methods inherited from class com.fasterxml.jackson.databind.jsontype.impl.TypeSerializerBase

getTypeIdResolver, writeTypePrefix, writeTypeSuffix

Methods inherited from class com.fasterxml.jackson.databind.jsontype.TypeSerializer

typeId, typeId, typeId, writeCustomTypePrefixForArray, writeCustomTypePrefixForObject, writeCustomTypePrefixForScalar, writeCustomTypeSuffixForArray, writeCustomTypeSuffixForObject, writeCustomTypeSuffixForScalar, writeTypePrefixForArray, writeTypePrefixForArray, writeTypePrefixForObject, writeTypePrefixForObject, writeTypePrefixForScalar, writeTypePrefixForScalar, writeTypeSuffixForArray, writeTypeSuffixForObject, writeTypeSuffixForScalar

Methods inherited from class java.lang.Object

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

Constructor Detail

AsExternalTypeSerializer

public AsExternalTypeSerializer(TypeIdResolver idRes,
                                BeanProperty property,
                                String propName)

Method Detail

forProperty

public AsExternalTypeSerializer forProperty(BeanProperty prop)

Description copied from class: TypeSerializer

Method called to create contextual version, to be used for values of given property. This may be the type itself (as is the case for bean properties), or values contained (for Collection or Map valued properties).

Specified by:

forProperty in class TypeSerializer

getPropertyName

public String getPropertyName()

Description copied from class: TypeSerializer

Name of property that contains type information, if property-based inclusion is used.

Overrides:

getPropertyName in class TypeSerializerBase

getTypeInclusion

public JsonTypeInfo.As getTypeInclusion()

Description copied from class: TypeSerializer

Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.

Specified by:

getTypeInclusion in class TypeSerializerBase