Module tools.jackson.databind
Package tools.jackson.databind.ser.jdk

Class MapEntrySerializer

java.lang.Object
tools.jackson.databind.ValueSerializer<T>
tools.jackson.databind.ser.std.StdSerializer<T>
tools.jackson.databind.ser.std.StdContainerSerializer<Map.Entry<?,?>>
tools.jackson.databind.ser.jdk.MapEntrySerializer
All Implemented Interfaces:
JsonFormatVisitable
public class MapEntrySerializer extends StdContainerSerializer<Map.Entry<?,?>>

  • Field Details

    • MARKER_FOR_EMPTY

      public static final Object MARKER_FOR_EMPTY

    • _valueTypeIsStatic

      protected final boolean _valueTypeIsStatic
      Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)

    • _entryType

      protected final JavaType _entryType

    • _keyType

      protected final JavaType _keyType

    • _valueType

      protected final JavaType _valueType

    • _keySerializer

      protected ValueSerializer<Object> _keySerializer
      Key serializer to use, if it can be statically determined

    • _valueSerializer

      protected ValueSerializer<Object> _valueSerializer
      Value serializer to use, if it can be statically determined

    • _valueTypeSerializer

      protected final TypeSerializer _valueTypeSerializer
      Type identifier serializer used for values, if any.

    • _suppressableValue

      protected final Object _suppressableValue
      Value that indicates suppression mechanism to use for values contained; either "filter" (of which equals() is called), or marker value of MARKER_FOR_EMPTY, or null to indicate no filtering for non-null values. Note that inclusion value for Map instance itself is handled by caller (POJO property that refers to the Map value).

    • _suppressNulls

      protected final boolean _suppressNulls
      Flag that indicates what to do with `null` values, distinct from handling of _suppressableValue

  • Constructor Details

  • Method Details

    • _withValueTypeSerializer

      public StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)
      Description copied from class: StdContainerSerializer
      Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.
      Specified by:
      _withValueTypeSerializer in class StdContainerSerializer<Map.Entry<?,?>>

    • withResolved

      public MapEntrySerializer withResolved(BeanProperty property, ValueSerializer<?> keySerializer, ValueSerializer<?> valueSerializer, Object suppressableValue, boolean suppressNulls)

    • withContentInclusion

      public MapEntrySerializer withContentInclusion(Object suppressableValue, boolean suppressNulls)

    • createContextual

      public ValueSerializer<?> createContextual(SerializationContext provider, BeanProperty property)
      Description copied from class: ValueSerializer
      Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). 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.

      Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

      Overrides:
      createContextual in class ValueSerializer<Map.Entry<?,?>>
      Parameters:
      provider - Context to use for accessing config, other serializers
      property - Property (defined by one or more accessors - field or method - used for accessing logical property value) for which serializer is used to be used; or, `null` for root value (or in cases where caller does not have this information, which is handled as root value case).
      Returns:
      Serializer to use for serializing values of specified property; may be this instance or a new instance.

    • getContentType

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

    • getContentSerializer

      public ValueSerializer<?> getContentSerializer()
      Description copied from class: StdContainerSerializer
      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 StdContainerSerializer.getContentType() and SerializationContext.findContentValueSerializer(tools.jackson.databind.JavaType, tools.jackson.databind.BeanProperty).
      Specified by:
      getContentSerializer in class StdContainerSerializer<Map.Entry<?,?>>

    • hasSingleElement

      public boolean hasSingleElement(Map.Entry<?,?> value)
      Description copied from class: StdContainerSerializer
      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 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 StdContainerSerializer<Map.Entry<?,?>>

    • isEmpty

      public boolean isEmpty(SerializationContext ctxt, Map.Entry<?,?> entry)
      Description copied from class: ValueSerializer
      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.

      Specified by:
      isEmpty in class StdContainerSerializer<Map.Entry<?,?>>

    • serialize

      public void serialize(Map.Entry<?,?> value, JsonGenerator g, SerializationContext ctxt) throws JacksonException
      Description copied from class: ValueSerializer
      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.
      g - Generator used to output resulting Json content
      ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.
      Throws:
      JacksonException

    • serializeWithType

      public void serializeWithType(Map.Entry<?,?> value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException
      Description copied from class: ValueSerializer
      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 ValueSerializer<Map.Entry<?,?>>
      Parameters:
      value - Value to serialize; can not be null.
      g - Generator used to output resulting Json content
      ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.
      typeSer - Type serializer to use for including type information
      Throws:
      JacksonException

    • serializeDynamic

      protected void serializeDynamic(Map.Entry<?,?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException
      Throws:
      JacksonException