org.codehaus.jackson.map
Class TypeSerializer

java.lang.Object
  extended by 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 regular JsonSerializers using proper contextual calls, to add type information using mechanism type serializer was configured with.

Since:
1.5
Author:
tatus

Constructor Summary
TypeSerializer()
           
 
Method Summary
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).
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).
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).
abstract  void writeTypeSuffixForArray(Object value, JsonGenerator jgen)
           
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, 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 to writeTypePrefixForScalar(java.lang.Object, org.codehaus.jackson.JsonGenerator).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypeSerializer

public TypeSerializer()
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 written
jgen - 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 written
jgen - 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 written
jgen - 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 to writeTypePrefixForScalar(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

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 to 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.

Throws:
IOException
JsonProcessingException

writeTypeSuffixForArray

public abstract void writeTypeSuffixForArray(Object value,
                                             JsonGenerator jgen)
                                      throws IOException,
                                             JsonProcessingException
Throws:
IOException
JsonProcessingException