Module tools.jackson.databind

Package tools.jackson.databind.jsontype.impl

Class TypeSerializerBase

java.lang.Object

tools.jackson.databind.jsontype.TypeSerializer

tools.jackson.databind.jsontype.impl.TypeSerializerBase

Direct Known Subclasses:

AsArrayTypeSerializer, AsDeductionTypeSerializer, AsExistingPropertyTypeSerializer, AsExternalTypeSerializer, AsPropertyTypeSerializer, AsWrapperTypeSerializer

public abstract class TypeSerializerBase
extends TypeSerializer

Field Summary

Fields

Modifier and Type	Field	Description
protected final TypeIdResolver	_idResolver
protected final BeanProperty	_property
protected final Class<?>	_skipTypeIdFor	When non-null, the default implementation class for which the type id will be suppressed during serialization: if the runtime value class exactly matches this class, no type id is written.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeSerializerBase(TypeIdResolver idRes, BeanProperty property)	Deprecated. Since 3.2 use variant with 3 arguments
protected	TypeSerializerBase(TypeIdResolver idRes, BeanProperty property, Class<?> skipTypeIdFor)

Method Summary

Modifier and Type	Method	Description
protected void	_generateTypeId(DatabindContext ctxt, WritableTypeId idMetadata)	Helper method that will generate type id to use, if not already passed.
String	getPropertyName()	Name of property that contains type information, if property-based inclusion is used.
TypeIdResolver	getTypeIdResolver()	Accessor for object that handles conversions between types and matching type ids.
abstract JsonTypeInfo.As	getTypeInclusion()	Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.
protected void	handleMissingId(Object value)
protected String	idFromValue(DatabindContext ctxt, Object value)
protected String	idFromValueAndType(DatabindContext ctxt, Object value, Class<?> type)
WritableTypeId	writeTypePrefix(JsonGenerator g, SerializationContext ctxt, WritableTypeId idMetadata)	Method called to write initial part of type information for given value, along with possible wrapping to use: details are specified by `typeId` argument.
WritableTypeId	writeTypeSuffix(JsonGenerator g, SerializationContext ctxt, WritableTypeId idMetadata)	Method called to write the "closing" part of type information for given value, along with possible closing wrapping to use: details are specified by `typeId` argument, which should be one returned from an earlier matching call to writeTypePrefix(...).

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

forProperty, typeId, typeId, typeId

Methods inherited from class java.lang.Object

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

Field Details

_idResolver

protected final TypeIdResolver _idResolver

_property

protected final BeanProperty _property

_skipTypeIdFor

protected final Class<?> _skipTypeIdFor

When non-null, the default implementation class for which the type id will be suppressed during serialization: if the runtime value class exactly matches this class, no type id is written. When null, type id is always written.

Since:

3.2

Constructor Details

TypeSerializerBase

protected TypeSerializerBase(TypeIdResolver idRes,
 BeanProperty property,
 Class<?> skipTypeIdFor)

Parameters:

skipTypeIdFor - if non-null, type id will be suppressed during serialization when the runtime value class exactly matches this class

Since:

3.2

TypeSerializerBase

@Deprecated
protected TypeSerializerBase(TypeIdResolver idRes,
 BeanProperty property)

Deprecated.

Since 3.2 use variant with 3 arguments

Method Details

getTypeInclusion

public abstract 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 TypeSerializer

getPropertyName

public String getPropertyName()

Description copied from class: TypeSerializer

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

Specified by:

getPropertyName in class TypeSerializer

getTypeIdResolver

public TypeIdResolver getTypeIdResolver()

Description copied from class: TypeSerializer

Accessor for object that handles conversions between types and matching type ids.

Specified by:

getTypeIdResolver in class TypeSerializer

writeTypePrefix

public WritableTypeId writeTypePrefix(JsonGenerator g,
 SerializationContext ctxt,
 WritableTypeId idMetadata)
                               throws JacksonException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, along with possible wrapping to use: details are specified by `typeId` argument. Note that for structured types (Object, Array), this call will add necessary start token so it should NOT be explicitly written, unlike with non-type-id value writes.

Specified by:

writeTypePrefix in class TypeSerializer

Parameters:

g - Generator to use for outputting type id and possible wrapping

idMetadata - Details of what type id is to be written, how.

Throws:

JacksonException

writeTypeSuffix

public WritableTypeId writeTypeSuffix(JsonGenerator g,
 SerializationContext ctxt,
 WritableTypeId idMetadata)
                               throws JacksonException

Description copied from class: TypeSerializer

Method called to write the "closing" part of type information for given value, along with possible closing wrapping to use: details are specified by `typeId` argument, which should be one returned from an earlier matching call to writeTypePrefix(...).

Specified by:

writeTypeSuffix in class TypeSerializer

Parameters:

g - Generator to use for outputting type id and possible wrapping

idMetadata - Details of what type id is to be written, how.

Throws:

JacksonException

_generateTypeId

protected void _generateTypeId(DatabindContext ctxt,
 WritableTypeId idMetadata)

Helper method that will generate type id to use, if not already passed.

idFromValue

protected String idFromValue(DatabindContext ctxt,
 Object value)

idFromValueAndType

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

handleMissingId

protected void handleMissingId(Object value)