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

Class MapEntrySerializer

java.lang.Object
com.fasterxml.jackson.databind.JsonSerializer<Map.Entry<?,?>>
com.fasterxml.jackson.databind.ser.std.StdSerializer<Map.Entry<?,?>>
com.fasterxml.jackson.databind.ser.ContainerSerializer<Map.Entry<?,?>>
com.fasterxml.jackson.databind.ser.impl.MapEntrySerializer
All Implemented Interfaces:
JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable
public class MapEntrySerializer extends ContainerSerializer<Map.Entry<?,?>> implements ContextualSerializer
Since:
2.5
See Also:

  • Field Details

    • MARKER_FOR_EMPTY

      public static final Object MARKER_FOR_EMPTY
      Since:
      2.9

  • Constructor Details

  • Method Details

    • _withValueTypeSerializer

      public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

    • withResolved

      public MapEntrySerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls)
      Since:
      2.9

    • withContentInclusion

      public MapEntrySerializer withContentInclusion(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

    • getContentType

      public JavaType getContentType()
      Description copied from class: ContainerSerializer
      Accessor for finding declared (static) element type for type this serializer is used for.
      Specified by:
      getContentType in class ContainerSerializer<Map.Entry<?,?>>

    • getContentSerializer

      public JsonSerializer<?> getContentSerializer()
      Description copied from class: ContainerSerializer
      Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. Note that for dynamic types this may return null; if so, caller has to instead use ContainerSerializer.getContentType() and SerializerProvider.findContentValueSerializer(com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.BeanProperty).
      Specified by:
      getContentSerializer in class ContainerSerializer<Map.Entry<?,?>>

    • hasSingleElement

      public boolean hasSingleElement(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<Map.Entry<?,?>>

    • isEmpty

      public boolean isEmpty(SerializerProvider prov, 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<Map.Entry<?,?>>

    • serialize

      public void serialize(Map.Entry<?,?> value, JsonGenerator gen, SerializerProvider provider) throws 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<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:
      IOException

    • serializeWithType

      public void serializeWithType(Map.Entry<?,?> value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws 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<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:
      IOException