Package com.fasterxml.jackson.databind.ser.impl

Class MapEntrySerializer

    • Field Detail

      • MARKER_FOR_EMPTY

        public static final java.lang.Object MARKER_FOR_EMPTY
        Since:
        2.9

    • Method Detail

      • withContentInclusion

        public MapEntrySerializer withContentInclusion​(java.lang.Object suppressableValue,
                                               boolean suppressNulls)
        Since:
        2.9

      • createContextual

        public JsonSerializer<?> createContextual​(SerializerProvider provider,
                                          BeanProperty property)
                                   throws JsonMappingException
        Description copied from interface: ContextualSerializer
        Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.
        Specified by:
        createContextual in interface ContextualSerializer
        Parameters:
        provider - Serializer provider to use for accessing config, other serializers
        property - Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)
        Returns:
        Serializer to use for serializing values of specified property; may be this instance or a new instance.
        Throws:
        JsonMappingException

      • hasSingleElement

        public boolean hasSingleElement​(java.util.Map.Entry<?,​?> value)
        Description copied from class: ContainerSerializer
        Method called to determine if the given value (of type handled by this serializer) contains exactly one element.

        Note: although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).

        Note, too, that as of now (2.9) this method is only called by serializer itself; and specifically is not used for non-array/collection types like Map or Map.Entry instances.

        Specified by:
        hasSingleElement in class ContainerSerializer<java.util.Map.Entry<?,​?>>

      • isEmpty

        public boolean isEmpty​(SerializerProvider prov,
                       java.util.Map.Entry<?,​?> entry)
        Description copied from class: JsonSerializer
        Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

        Default implementation will consider only null values to be empty.

        NOTE: replaces JsonSerializer.isEmpty(Object), which was deprecated in 2.5

        Overrides:
        isEmpty in class JsonSerializer<java.util.Map.Entry<?,​?>>

      • serialize

        public void serialize​(java.util.Map.Entry<?,​?> value,
                      JsonGenerator gen,
                      SerializerProvider provider)
               throws java.io.IOException
        Description copied from class: JsonSerializer
        Method that can be called to ask implementation to serialize values of type this serializer handles.
        Specified by:
        serialize in class StdSerializer<java.util.Map.Entry<?,​?>>
        Parameters:
        value - Value to serialize; can not be null.
        gen - Generator used to output resulting Json content
        provider - Provider that can be used to get serializers for serializing Objects value contains, if any.
        Throws:
        java.io.IOException

      • serializeWithType

        public void serializeWithType​(java.util.Map.Entry<?,​?> value,
                              JsonGenerator g,
                              SerializerProvider provider,
                              TypeSerializer typeSer)
                       throws java.io.IOException
        Description copied from class: JsonSerializer
        Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

        Default implementation will throw UnsupportedOperationException to indicate that proper type handling needs to be implemented.

        For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like: 

          // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, gen);
  serialize(value, gen, provider);
  typeSer.writeTypeSuffixForScalar(value, gen);
        and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.
        Overrides:
        serializeWithType in class JsonSerializer<java.util.Map.Entry<?,​?>>
        Parameters:
        value - Value to serialize; can not be null.
        g - Generator used to output resulting Json content
        provider - Provider that can be used to get serializers for serializing Objects value contains, if any.
        typeSer - Type serializer to use for including type information
        Throws:
        java.io.IOException