Module tools.jackson.databind

Package tools.jackson.databind.jsontype.impl

Class AsPropertyTypeSerializer

java.lang.Object

tools.jackson.databind.jsontype.TypeSerializer

tools.jackson.databind.jsontype.impl.TypeSerializerBase

tools.jackson.databind.jsontype.impl.AsPropertyTypeSerializer

public class AsPropertyTypeSerializer
extends TypeSerializerBase

Type serializer that preferably embeds type information as an additional JSON Object property, if possible (when resulting serialization would use JSON Object). If this is not possible (for JSON Arrays, scalars), uses a JSON Array wrapper (similar to how JsonTypeInfo.As.WRAPPER_ARRAY always works) as a fallback.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	_typePropertyName

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

_idResolver, _property

Constructor Summary

Constructors

Constructor	Description
AsPropertyTypeSerializer(TypeIdResolver idRes, BeanProperty property, String propName)

Method Summary

Modifier and Type	Method	Description
AsPropertyTypeSerializer	forProperty(SerializationContext ctxt, 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 tools.jackson.databind.jsontype.impl.TypeSerializerBase

_generateTypeId, getTypeIdResolver, handleMissingId, idFromValue, idFromValueAndType, writeTypePrefix, writeTypeSuffix

Methods inherited from class tools.jackson.databind.jsontype.TypeSerializer

typeId, typeId, typeId

Methods inherited from class java.lang.Object

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

Field Details

_typePropertyName

protected final String _typePropertyName

Constructor Details

AsPropertyTypeSerializer

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

Method Details

forProperty

public AsPropertyTypeSerializer forProperty(SerializationContext ctxt,
 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).

NOTE: since 3.0 has received context object as first argument.

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