Class AsExternalTypeSerializer


  • public class AsExternalTypeSerializer
    extends TypeSerializerBase
    Type serializer that preferably embeds type information as an "external" type property; embedded in enclosing JSON object. Note that this serializer should only be used when value is being output at JSON Object context; otherwise it cannot work reliably, and will have to revert operation similar to AsPropertyTypeSerializer.

    Note that implementation of serialization is bit cumbersome as we must serialized external type id AFTER object; this because callback only occurs after field name has been written.

    Also note that this type of type id inclusion will NOT try to make use of native Type Ids, even if those exist.

    • Field Detail

      • _typePropertyName

        protected final java.lang.String _typePropertyName
    • Constructor Detail

      • AsExternalTypeSerializer

        public AsExternalTypeSerializer​(TypeIdResolver idRes,
                                        BeanProperty property,
                                        java.lang.String propName)
    • Method Detail

      • forProperty

        public AsExternalTypeSerializer forProperty​(BeanProperty prop)
        Description copied from class: TypeSerializer
        Method called to create contextual version, to be used for values of given property. This may be the type itself (as is the case for bean properties), or values contained (for Collection or Map valued properties).
        Specified by:
        forProperty in class TypeSerializer
      • getPropertyName

        public java.lang.String getPropertyName()
        Description copied from class: TypeSerializer
        Name of property that contains type information, if property-based inclusion is used.
        Overrides:
        getPropertyName in class TypeSerializerBase
      • getTypeInclusion

        public com.fasterxml.jackson.annotation.JsonTypeInfo.As getTypeInclusion()
        Description copied from class: TypeSerializer
        Accessor for type information inclusion method that serializer uses; indicates how type information is embedded in resulting JSON.
        Specified by:
        getTypeInclusion in class TypeSerializerBase
      • _writeScalarPrefix

        protected final void _writeScalarPrefix​(java.lang.Object value,
                                                com.fasterxml.jackson.core.JsonGenerator g)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • _writeObjectPrefix

        protected final void _writeObjectPrefix​(java.lang.Object value,
                                                com.fasterxml.jackson.core.JsonGenerator g)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • _writeArrayPrefix

        protected final void _writeArrayPrefix​(java.lang.Object value,
                                               com.fasterxml.jackson.core.JsonGenerator g)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • _writeScalarSuffix

        protected final void _writeScalarSuffix​(java.lang.Object value,
                                                com.fasterxml.jackson.core.JsonGenerator g,
                                                java.lang.String typeId)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • _writeObjectSuffix

        protected final void _writeObjectSuffix​(java.lang.Object value,
                                                com.fasterxml.jackson.core.JsonGenerator g,
                                                java.lang.String typeId)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • _writeArraySuffix

        protected final void _writeArraySuffix​(java.lang.Object value,
                                               com.fasterxml.jackson.core.JsonGenerator g,
                                               java.lang.String typeId)
                                        throws java.io.IOException
        Throws:
        java.io.IOException