Class TypeSerializer

  • Direct Known Subclasses:
    TypeSerializerBase

    public abstract class TypeSerializer
    extends java.lang.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 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 java.lang.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​(java.lang.Object value,
                                                      JsonGenerator jgen)
                                               throws java.io.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:
        java.io.IOException
        JsonProcessingException
      • writeTypePrefixForObject

        public abstract void writeTypePrefixForObject​(java.lang.Object value,
                                                      JsonGenerator jgen)
                                               throws java.io.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:
        java.io.IOException
        JsonProcessingException
      • writeTypePrefixForArray

        public abstract void writeTypePrefixForArray​(java.lang.Object value,
                                                     JsonGenerator jgen)
                                              throws java.io.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:
        java.io.IOException
        JsonProcessingException
      • writeTypePrefixForScalar

        public void writeTypePrefixForScalar​(java.lang.Object value,
                                             JsonGenerator jgen,
                                             java.lang.Class<?> type)
                                      throws java.io.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:
        java.io.IOException
        JsonProcessingException
        Since:
        1.8
      • writeTypePrefixForObject

        public void writeTypePrefixForObject​(java.lang.Object value,
                                             JsonGenerator jgen,
                                             java.lang.Class<?> type)
                                      throws java.io.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:
        java.io.IOException
        JsonProcessingException
        Since:
        1.8
      • writeTypePrefixForArray

        public void writeTypePrefixForArray​(java.lang.Object value,
                                            JsonGenerator jgen,
                                            java.lang.Class<?> type)
                                     throws java.io.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:
        java.io.IOException
        JsonProcessingException
        Since:
        1.8