Package org.codehaus.jackson.map
Class TypeSerializer
- java.lang.Object
-
- org.codehaus.jackson.map.TypeSerializer
-
- Direct Known Subclasses:
TypeSerializerBase
public abstract class TypeSerializer extends Object
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 regularJsonSerializer
s using proper contextual calls, to add type information using mechanism type serializer was configured with.- Since:
- 1.5
- Author:
- tatus
-
-
Constructor Summary
Constructors Constructor Description TypeSerializer()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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
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 typeabstract 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 typeabstract 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 typeabstract void
writeTypeSuffixForArray(Object value, JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypeSuffixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator)
.abstract void
writeTypeSuffixForObject(Object value, JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypePrefixForObject(java.lang.Object, org.codehaus.jackson.JsonGenerator)
.abstract void
writeTypeSuffixForScalar(Object value, JsonGenerator jgen)
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypePrefixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator)
.
-
-
-
Method Detail
-
getTypeInclusion
public abstract JsonTypeInfo.As getTypeInclusion()
Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.
-
getPropertyName
public abstract String getPropertyName()
Name of property that contains type information, if property-based inclusion is used.
-
getTypeIdResolver
public abstract TypeIdResolver getTypeIdResolver()
Accessor for object that handles conversions between types and matching type ids.
-
writeTypePrefixForScalar
public abstract void writeTypePrefixForScalar(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
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.- Parameters:
value
- Value that will be serialized, for which type information is to be writtenjgen
- Generator to use for writing type information- Throws:
IOException
JsonProcessingException
-
writeTypePrefixForObject
public abstract void writeTypePrefixForObject(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
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.- Parameters:
value
- Value that will be serialized, for which type information is to be writtenjgen
- Generator to use for writing type information- Throws:
IOException
JsonProcessingException
-
writeTypePrefixForArray
public abstract void writeTypePrefixForArray(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
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.- Parameters:
value
- Value that will be serialized, for which type information is to be writtenjgen
- Generator to use for writing type information- Throws:
IOException
JsonProcessingException
-
writeTypeSuffixForScalar
public abstract void writeTypeSuffixForScalar(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypePrefixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator)
. Actual action to take may depend on various factors, but has to match with actionwriteTypePrefixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator)
did (close array or object; or do nothing).- Throws:
IOException
JsonProcessingException
-
writeTypeSuffixForObject
public abstract void writeTypeSuffixForObject(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypePrefixForObject(java.lang.Object, org.codehaus.jackson.JsonGenerator)
. It needs to write closing END_OBJECT marker, and any other decoration that needs to be matched.- Throws:
IOException
JsonProcessingException
-
writeTypeSuffixForArray
public abstract void writeTypeSuffixForArray(Object value, JsonGenerator jgen) throws IOException, JsonProcessingException
Method called after value has been serialized, to close any scopes opened by earlier matching call towriteTypeSuffixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator)
. It needs to write closing END_ARRAY marker, and any other decoration that needs to be matched.- Throws:
IOException
JsonProcessingException
-
writeTypePrefixForScalar
public void writeTypePrefixForScalar(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
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- Throws:
IOException
JsonProcessingException
- Since:
- 1.8
-
writeTypePrefixForObject
public void writeTypePrefixForObject(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
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- Throws:
IOException
JsonProcessingException
- Since:
- 1.8
-
writeTypePrefixForArray
public void writeTypePrefixForArray(Object value, JsonGenerator jgen, Class<?> type) throws IOException, JsonProcessingException
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- Throws:
IOException
JsonProcessingException
- Since:
- 1.8
-
-