Package org.codehaus.jackson.map.jsontype.impl

Class AsPropertyTypeSerializer

java.lang.Object

org.codehaus.jackson.map.TypeSerializer

org.codehaus.jackson.map.jsontype.impl.TypeSerializerBase

org.codehaus.jackson.map.jsontype.impl.AsArrayTypeSerializer

org.codehaus.jackson.map.jsontype.impl.AsPropertyTypeSerializer

public class AsPropertyTypeSerializer
extends AsArrayTypeSerializer

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.

Since:

1.5

Author:

tatus

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_typePropertyName

Fields inherited from class org.codehaus.jackson.map.jsontype.impl.TypeSerializerBase

_idResolver, _property

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.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.
void	writeTypePrefixForObject(java.lang.Object value, JsonGenerator jgen)	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(java.lang.Object value, JsonGenerator jgen, java.lang.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	writeTypeSuffixForObject(java.lang.Object value, JsonGenerator jgen)	Method called after value has been serialized, to close any scopes opened by earlier matching call to TypeSerializer.writeTypePrefixForObject(java.lang.Object, org.codehaus.jackson.JsonGenerator).

Methods inherited from class org.codehaus.jackson.map.jsontype.impl.AsArrayTypeSerializer

writeTypePrefixForArray, writeTypePrefixForArray, writeTypePrefixForScalar, writeTypePrefixForScalar, writeTypeSuffixForArray, writeTypeSuffixForScalar

Methods inherited from class org.codehaus.jackson.map.jsontype.impl.TypeSerializerBase

getTypeIdResolver

Methods inherited from class java.lang.Object

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

Field Detail

_typePropertyName

protected final java.lang.String _typePropertyName

Constructor Detail

AsPropertyTypeSerializer

public AsPropertyTypeSerializer(TypeIdResolver idRes,
                                BeanProperty property,
                                java.lang.String propName)

Method Detail

getPropertyName

public java.lang.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.

Overrides:

getTypeInclusion in class AsArrayTypeSerializer

writeTypePrefixForObject

public void writeTypePrefixForObject(java.lang.Object value,
                                     JsonGenerator jgen)
                              throws java.io.IOException,
                                     JsonProcessingException

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.

Overrides:

writeTypePrefixForObject in class AsArrayTypeSerializer

Parameters:

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

jgen - Generator to use for writing type information

Throws:

java.io.IOException

JsonProcessingException

writeTypePrefixForObject

public void writeTypePrefixForObject(java.lang.Object value,
                                     JsonGenerator jgen,
                                     java.lang.Class<?> type)
                              throws java.io.IOException,
                                     JsonProcessingException

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 AsArrayTypeSerializer

Throws:

java.io.IOException

JsonProcessingException

writeTypeSuffixForObject

public void writeTypeSuffixForObject(java.lang.Object value,
                                     JsonGenerator jgen)
                              throws java.io.IOException,
                                     JsonProcessingException

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, org.codehaus.jackson.JsonGenerator). It needs to write closing END_OBJECT marker, and any other decoration that needs to be matched.

Overrides:

writeTypeSuffixForObject in class AsArrayTypeSerializer

Throws:

java.io.IOException

JsonProcessingException