|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fasterxml.jackson.databind.jsontype.TypeSerializer
com.fasterxml.jackson.databind.jsontype.impl.TypeSerializerBase
com.fasterxml.jackson.databind.jsontype.impl.AsExternalTypeSerializer
public class AsExternalTypeSerializer
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 can not 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.
| Field Summary | |
|---|---|
protected String |
_typePropertyName
|
| Fields inherited from class com.fasterxml.jackson.databind.jsontype.impl.TypeSerializerBase |
|---|
_idResolver, _property |
| Constructor Summary | |
|---|---|
AsExternalTypeSerializer(TypeIdResolver idRes,
BeanProperty property,
String propName)
|
|
| Method Summary | |
|---|---|
protected void |
_writePrefix(Object value,
JsonGenerator jgen)
|
protected void |
_writePrefix(Object value,
JsonGenerator jgen,
Class<?> type)
|
protected void |
_writeSuffix(Object value,
JsonGenerator jgen,
String typeId)
|
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. |
void |
writeCustomTypePrefixForArray(Object value,
JsonGenerator jgen,
String typeId)
|
void |
writeCustomTypePrefixForObject(Object value,
JsonGenerator jgen,
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 jgen,
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 jgen,
String typeId)
|
void |
writeCustomTypeSuffixForObject(Object value,
JsonGenerator jgen,
String typeId)
|
void |
writeCustomTypeSuffixForScalar(Object value,
JsonGenerator jgen,
String typeId)
|
void |
writeTypePrefixForArray(Object value,
JsonGenerator jgen)
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 jgen,
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 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(Object value,
JsonGenerator jgen,
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 jgen)
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 jgen,
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 jgen)
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 jgen)
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 jgen)
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 |
|---|
getTypeIdResolver, idFromValue, idFromValueAndType |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final String _typePropertyName
| Constructor Detail |
|---|
public AsExternalTypeSerializer(TypeIdResolver idRes,
BeanProperty property,
String propName)
| Method Detail |
|---|
public AsExternalTypeSerializer forProperty(BeanProperty prop)
TypeSerializerCollection or Map
valued properties).
forProperty in class TypeSerializerpublic String getPropertyName()
TypeSerializer
getPropertyName in class TypeSerializerBasepublic JsonTypeInfo.As getTypeInclusion()
TypeSerializer
getTypeInclusion in class TypeSerializerBase
public void writeTypePrefixForObject(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForObject in class TypeSerializervalue - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type information
IOException
JsonProcessingException
public void writeTypePrefixForObject(Object value,
JsonGenerator jgen,
Class<?> type)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForObject in class TypeSerializerIOException
JsonProcessingException
public void writeTypePrefixForArray(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForArray in class TypeSerializervalue - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type information
IOException
JsonProcessingException
public void writeTypePrefixForArray(Object value,
JsonGenerator jgen,
Class<?> type)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForArray in class TypeSerializerIOException
JsonProcessingException
public void writeTypePrefixForScalar(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForScalar in class TypeSerializervalue - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type information
IOException
JsonProcessingException
public void writeTypePrefixForScalar(Object value,
JsonGenerator jgen,
Class<?> type)
throws IOException,
JsonProcessingException
TypeSerializer
writeTypePrefixForScalar in class TypeSerializerIOException
JsonProcessingException
public void writeTypeSuffixForObject(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializerTypeSerializer.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.
writeTypeSuffixForObject in class TypeSerializerIOException
JsonProcessingException
public void writeTypeSuffixForArray(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializerTypeSerializer.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.
writeTypeSuffixForArray in class TypeSerializerIOException
JsonProcessingException
public void writeTypeSuffixForScalar(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
TypeSerializerTypeSerializer.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).
writeTypeSuffixForScalar in class TypeSerializerIOException
JsonProcessingException
public void writeCustomTypePrefixForScalar(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
TypeSerializerTypeIdResolver.
This means that the context after call can not be that of JSON Object;
it may be Array or root context.
writeCustomTypePrefixForScalar in class TypeSerializervalue - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationtypeId - Exact type id to use
IOException
JsonProcessingException
public void writeCustomTypePrefixForObject(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
TypeSerializerTypeIdResolver.
This means that context after call must be JSON Object, meaning that
caller can then proceed to output field entries.
writeCustomTypePrefixForObject in class TypeSerializervalue - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationtypeId - Exact type id to use
IOException
JsonProcessingException
public void writeCustomTypePrefixForArray(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
writeCustomTypePrefixForArray in class TypeSerializerIOException
JsonProcessingException
public void writeCustomTypeSuffixForScalar(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
writeCustomTypeSuffixForScalar in class TypeSerializerIOException
JsonProcessingException
public void writeCustomTypeSuffixForObject(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
writeCustomTypeSuffixForObject in class TypeSerializerIOException
JsonProcessingException
public void writeCustomTypeSuffixForArray(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
writeCustomTypeSuffixForArray in class TypeSerializerIOException
JsonProcessingException
protected final void _writePrefix(Object value,
JsonGenerator jgen)
throws IOException,
JsonProcessingException
IOException
JsonProcessingException
protected final void _writePrefix(Object value,
JsonGenerator jgen,
Class<?> type)
throws IOException,
JsonProcessingException
IOException
JsonProcessingException
protected final void _writeSuffix(Object value,
JsonGenerator jgen,
String typeId)
throws IOException,
JsonProcessingException
IOException
JsonProcessingException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||