com.fasterxml.jackson.databind.jsontype.impl

Class AsWrapperTypeSerializer

java.lang.Object

com.fasterxml.jackson.databind.jsontype.TypeSerializer

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

com.fasterxml.jackson.databind.jsontype.impl.AsWrapperTypeSerializer

public class AsWrapperTypeSerializer
extends TypeSerializerBase

Type wrapper that tries to use an extra JSON Object, with a single entry that has type name as key, to serialize type information. If this is not possible (value is serialize as array or primitive), will use JsonTypeInfo.As.WRAPPER_ARRAY mechanism as fallback: that is, just use a wrapping array with type information as the first element and value as second.

Field Summary

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

_idResolver, _property

Constructor Summary

Constructors

Constructor and Description
AsWrapperTypeSerializer(TypeIdResolver idRes, BeanProperty property)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	_validTypeId(String typeId) Helper method used to ensure that intended type id is output as something that is valid: currently only used to ensure that `null` output is converted to an empty String.
AsWrapperTypeSerializer	forProperty(BeanProperty prop) Method called to create contextual version, to be used for values of given property.
JsonTypeInfo.As	getTypeInclusion() Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.
void	writeCustomTypePrefixForArray(Object value, JsonGenerator g, String typeId)
void	writeCustomTypePrefixForObject(Object value, JsonGenerator g, String typeId) Method called to write initial part of type information for given value, when it will be output as JSON Object value (not as JSON Array or scalar), using specified custom type id instead of calling TypeIdResolver.
void	writeCustomTypePrefixForScalar(Object value, JsonGenerator g, String typeId) Method called to write initial part of type information for given value, when it will be output as scalar JSON value (not as JSON Object or Array), using specified custom type id instead of calling TypeIdResolver.
void	writeCustomTypeSuffixForArray(Object value, JsonGenerator g, String typeId)
void	writeCustomTypeSuffixForObject(Object value, JsonGenerator g, String typeId)
void	writeCustomTypeSuffixForScalar(Object value, JsonGenerator g, String typeId)
void	writeTypePrefixForArray(Object value, JsonGenerator g) Method called to write initial part of type information for given value, when it will be output as JSON Array value (not as JSON Object or scalar).
void	writeTypePrefixForArray(Object value, JsonGenerator g, Class<?> type) Alternative version of the prefix-for-array method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type
void	writeTypePrefixForObject(Object value, JsonGenerator g) Method called to write initial part of type information for given value, when it will be output as JSON Object value (not as JSON Array or scalar).
void	writeTypePrefixForObject(Object value, JsonGenerator g, Class<?> type) Alternative version of the prefix-for-object method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type
void	writeTypePrefixForScalar(Object value, JsonGenerator g) Method called to write initial part of type information for given value, when it will be output as scalar JSON value (not as JSON Object or Array).
void	writeTypePrefixForScalar(Object value, JsonGenerator g, Class<?> type) Alternative version of the prefix-for-scalar method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type
void	writeTypeSuffixForArray(Object value, JsonGenerator g) Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypeSuffixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator).
void	writeTypeSuffixForObject(Object value, JsonGenerator g) Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypePrefixForObject(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator).
void	writeTypeSuffixForScalar(Object value, JsonGenerator g) Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator).

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

getPropertyName, getTypeIdResolver, handleMissingId, idFromValue, idFromValueAndType

Methods inherited from class java.lang.Object

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

Constructor Detail

AsWrapperTypeSerializer

public AsWrapperTypeSerializer(TypeIdResolver idRes,
                       BeanProperty property)

Method Detail

forProperty

public AsWrapperTypeSerializer 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

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

writeTypePrefixForObject

public void writeTypePrefixForObject(Object value,
                            JsonGenerator g)
                              throws IOException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, when it will be output as JSON Object value (not as JSON Array or scalar). This means that context after call must be JSON Object, meaning that caller can then proceed to output field entries.

Specified by:

writeTypePrefixForObject in class TypeSerializer

Parameters:

value - Value that will be serialized, for which type information is to be written

g - Generator to use for writing type information

Throws:

IOException

writeTypePrefixForObject

public void writeTypePrefixForObject(Object value,
                            JsonGenerator g,
                            Class<?> type)
                              throws IOException

Description copied from class: TypeSerializer

Alternative version of the prefix-for-object method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type

Overrides:

writeTypePrefixForObject in class TypeSerializer

Throws:

IOException

writeTypePrefixForArray

public void writeTypePrefixForArray(Object value,
                           JsonGenerator g)
                             throws IOException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, when it will be output as JSON Array value (not as JSON Object or scalar). This means that context after call must be JSON Array, that is, there must be an open START_ARRAY to write contents in.

Specified by:

writeTypePrefixForArray in class TypeSerializer

Parameters:

value - Value that will be serialized, for which type information is to be written

g - Generator to use for writing type information

Throws:

IOException

writeTypePrefixForArray

public void writeTypePrefixForArray(Object value,
                           JsonGenerator g,
                           Class<?> type)
                             throws IOException

Description copied from class: TypeSerializer

Alternative version of the prefix-for-array method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type

Overrides:

writeTypePrefixForArray in class TypeSerializer

Throws:

IOException

writeTypePrefixForScalar

public void writeTypePrefixForScalar(Object value,
                            JsonGenerator g)
                              throws IOException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, when it will be output as scalar JSON value (not as JSON Object or Array). This means that the context after call can not be that of JSON Object; it may be Array or root context.

Specified by:

writeTypePrefixForScalar in class TypeSerializer

Parameters:

value - Value that will be serialized, for which type information is to be written

g - Generator to use for writing type information

Throws:

IOException

writeTypePrefixForScalar

public void writeTypePrefixForScalar(Object value,
                            JsonGenerator g,
                            Class<?> type)
                              throws IOException

Description copied from class: TypeSerializer

Alternative version of the prefix-for-scalar method, which is given actual type to use (instead of using exact type of the value); typically a super type of actual value type

Overrides:

writeTypePrefixForScalar in class TypeSerializer

Throws:

IOException

writeTypeSuffixForObject

public void writeTypeSuffixForObject(Object value,
                            JsonGenerator g)
                              throws IOException

Description copied from class: TypeSerializer

Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypePrefixForObject(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). It needs to write closing END_OBJECT marker, and any other decoration that needs to be matched.

Specified by:

writeTypeSuffixForObject in class TypeSerializer

Throws:

IOException

writeTypeSuffixForArray

public void writeTypeSuffixForArray(Object value,
                           JsonGenerator g)
                             throws IOException

Description copied from class: TypeSerializer

Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypeSuffixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). It needs to write closing END_ARRAY marker, and any other decoration that needs to be matched.

Specified by:

writeTypeSuffixForArray in class TypeSerializer

Throws:

IOException

writeTypeSuffixForScalar

public void writeTypeSuffixForScalar(Object value,
                            JsonGenerator g)
                              throws IOException

Description copied from class: TypeSerializer

Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). Actual action to take may depend on various factors, but has to match with action TypeSerializer.writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator) did (close array or object; or do nothing).

Specified by:

writeTypeSuffixForScalar in class TypeSerializer

Throws:

IOException

writeCustomTypePrefixForObject

public void writeCustomTypePrefixForObject(Object value,
                                  JsonGenerator g,
                                  String typeId)
                                    throws IOException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, when it will be output as JSON Object value (not as JSON Array or scalar), using specified custom type id instead of calling TypeIdResolver. This means that context after call must be JSON Object, meaning that caller can then proceed to output field entries.

Specified by:

writeCustomTypePrefixForObject in class TypeSerializer

Parameters:

value - Value that will be serialized, for which type information is to be written

g - Generator to use for writing type information

typeId - Exact type id to use

Throws:

IOException

writeCustomTypePrefixForArray

public void writeCustomTypePrefixForArray(Object value,
                                 JsonGenerator g,
                                 String typeId)
                                   throws IOException

Specified by:

writeCustomTypePrefixForArray in class TypeSerializer

Throws:

IOException

writeCustomTypePrefixForScalar

public void writeCustomTypePrefixForScalar(Object value,
                                  JsonGenerator g,
                                  String typeId)
                                    throws IOException

Description copied from class: TypeSerializer

Method called to write initial part of type information for given value, when it will be output as scalar JSON value (not as JSON Object or Array), using specified custom type id instead of calling TypeIdResolver. This means that the context after call can not be that of JSON Object; it may be Array or root context.

Specified by:

writeCustomTypePrefixForScalar in class TypeSerializer

Parameters:

value - Value that will be serialized, for which type information is to be written

g - Generator to use for writing type information

typeId - Exact type id to use

Throws:

IOException

writeCustomTypeSuffixForObject

public void writeCustomTypeSuffixForObject(Object value,
                                  JsonGenerator g,
                                  String typeId)
                                    throws IOException

Specified by:

writeCustomTypeSuffixForObject in class TypeSerializer

Throws:

IOException

writeCustomTypeSuffixForArray

public void writeCustomTypeSuffixForArray(Object value,
                                 JsonGenerator g,
                                 String typeId)
                                   throws IOException

Specified by:

writeCustomTypeSuffixForArray in class TypeSerializer

Throws:

IOException

writeCustomTypeSuffixForScalar

public void writeCustomTypeSuffixForScalar(Object value,
                                  JsonGenerator g,
                                  String typeId)
                                    throws IOException

Specified by:

writeCustomTypeSuffixForScalar in class TypeSerializer

Throws:

IOException

_validTypeId

protected String _validTypeId(String typeId)

Helper method used to ensure that intended type id is output as something that is valid: currently only used to ensure that `null` output is converted to an empty String.

Since:

2.6