|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.fasterxml.jackson.databind.jsontype.TypeSerializer
public abstract class TypeSerializer
Interface for serializing type information regarding instances of specified
base type (super class), so that exact subtype can be properly deserialized
later on. These instances are to be called by regular
JsonSerializer
s using proper contextual
calls, to add type information using mechanism type serializer was
configured with.
Constructor Summary | |
---|---|
TypeSerializer()
|
Method Summary | |
---|---|
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 com.fasterxml.jackson.annotation.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,
com.fasterxml.jackson.core.JsonGenerator jgen,
String typeId)
|
abstract void |
writeCustomTypePrefixForObject(Object value,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.JsonGenerator jgen,
String typeId)
|
abstract void |
writeCustomTypeSuffixForObject(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
String typeId)
|
abstract void |
writeCustomTypeSuffixForScalar(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
String typeId)
|
abstract void |
writeTypePrefixForArray(Object value,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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,
com.fasterxml.jackson.core.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) . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TypeSerializer()
Method Detail |
---|
public abstract TypeSerializer forProperty(BeanProperty prop)
Collection
or Map
valued properties).
public abstract com.fasterxml.jackson.annotation.JsonTypeInfo.As getTypeInclusion()
public abstract String getPropertyName()
public abstract TypeIdResolver getTypeIdResolver()
public abstract void writeTypePrefixForScalar(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
value
- Value that will be serialized, for which type information is
to be writtenjgen
- Generator to use for writing type information
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeTypePrefixForObject(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
value
- Value that will be serialized, for which type information is
to be writtenjgen
- Generator to use for writing type information
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeTypePrefixForArray(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
value
- Value that will be serialized, for which type information is
to be writtenjgen
- Generator to use for writing type information
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeTypeSuffixForScalar(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.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).
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeTypeSuffixForObject(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.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.
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeTypeSuffixForArray(Object value, com.fasterxml.jackson.core.JsonGenerator jgen) throws IOException, com.fasterxml.jackson.core.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.
IOException
com.fasterxml.jackson.core.JsonProcessingException
public void writeTypePrefixForScalar(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, Class<?> type) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public void writeTypePrefixForObject(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, Class<?> type) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public void writeTypePrefixForArray(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, Class<?> type) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypePrefixForScalar(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.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 use
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypePrefixForObject(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.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 use
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypePrefixForArray(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypeSuffixForScalar(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypeSuffixForObject(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
public abstract void writeCustomTypeSuffixForArray(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, String typeId) throws IOException, com.fasterxml.jackson.core.JsonProcessingException
IOException
com.fasterxml.jackson.core.JsonProcessingException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |