public abstract class TypeSerializer extends Object
JsonSerializers using proper contextual
calls, to add type information using mechanism type serializer was
configured with.| Constructor and Description |
|---|
TypeSerializer() |
| Modifier and Type | Method and Description |
|---|---|
abstract TypeSerializer |
forProperty(BeanProperty prop)
Method called to create contextual version, to be used for
values of given property.
|
abstract String |
getPropertyName()
Name of property that contains type information, if
property-based inclusion is used.
|
abstract 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.
|
abstract void |
writeCustomTypePrefixForArray(Object value,
JsonGenerator jgen,
String typeId) |
abstract 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. |
abstract 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. |
abstract void |
writeCustomTypeSuffixForArray(Object value,
JsonGenerator jgen,
String typeId) |
abstract void |
writeCustomTypeSuffixForObject(Object value,
JsonGenerator jgen,
String typeId) |
abstract void |
writeCustomTypeSuffixForScalar(Object value,
JsonGenerator jgen,
String typeId) |
abstract 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
|
abstract 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
|
abstract 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
|
abstract void |
writeTypeSuffixForArray(Object value,
JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened
by earlier matching call to
writeTypeSuffixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). |
abstract void |
writeTypeSuffixForObject(Object value,
JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened
by earlier matching call to
writeTypePrefixForObject(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). |
abstract void |
writeTypeSuffixForScalar(Object value,
JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened
by earlier matching call to
writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator). |
public abstract TypeSerializer forProperty(BeanProperty prop)
Collection or Map
valued properties).public abstract JsonTypeInfo.As getTypeInclusion()
public abstract String getPropertyName()
public abstract TypeIdResolver getTypeIdResolver()
public abstract void writeTypePrefixForScalar(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
value - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationIOExceptionJsonProcessingExceptionpublic abstract void writeTypePrefixForObject(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
value - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationIOExceptionJsonProcessingExceptionpublic abstract void writeTypePrefixForArray(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
value - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationIOExceptionJsonProcessingExceptionpublic abstract void writeTypeSuffixForScalar(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator).
Actual action to take may depend on various factors, but has to match with
action writeTypePrefixForScalar(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator) did (close array or object; or do nothing).IOExceptionJsonProcessingExceptionpublic abstract void writeTypeSuffixForObject(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
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.IOExceptionJsonProcessingExceptionpublic abstract void writeTypeSuffixForArray(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
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.IOExceptionJsonProcessingExceptionpublic void writeTypePrefixForScalar(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic void writeTypePrefixForObject(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic void writeTypePrefixForArray(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypePrefixForScalar(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
TypeIdResolver.
This means that the context after call can not be that of JSON Object;
it may be Array or root context.value - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationtypeId - Exact type id to useIOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypePrefixForObject(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
TypeIdResolver.
This means that context after call must be JSON Object, meaning that
caller can then proceed to output field entries.value - Value that will be serialized, for which type information is
to be writtenjgen - Generator to use for writing type informationtypeId - Exact type id to useIOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypePrefixForArray(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypeSuffixForScalar(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypeSuffixForObject(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionpublic abstract void writeCustomTypeSuffixForArray(Object value, JsonGenerator jgen, String typeId) throws IOException, JsonProcessingException
IOExceptionJsonProcessingExceptionCopyright © 2012-2013 FasterXML. All Rights Reserved.