Module tools.jackson.databind
Package tools.jackson.databind.ser.std

Class ArraySerializerBase<T>

java.lang.Object
tools.jackson.databind.ValueSerializer<T>
tools.jackson.databind.ser.std.StdSerializer<T>
tools.jackson.databind.ser.std.StdContainerSerializer<T>
tools.jackson.databind.ser.std.ArraySerializerBase<T>
Type Parameters:
T - Type of arrays serializer handles
All Implemented Interfaces:
JsonFormatVisitable
Direct Known Subclasses:
JDKArraySerializers.BooleanArraySerializer, JDKArraySerializers.DoubleArraySerializer, JDKArraySerializers.IntArraySerializer, JDKArraySerializers.TypedPrimitiveArraySerializer, ObjectArraySerializer, StringArraySerializer
public abstract class ArraySerializerBase<T> extends StdContainerSerializer<T>
Intermediate base class for serializers used for various Java arrays.

  • Field Details

    • MARKER_FOR_EMPTY

      protected static final Object MARKER_FOR_EMPTY

    • _unwrapSingle

      protected final Boolean _unwrapSingle
      Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.

    • _suppressableValue

      protected final Object _suppressableValue
      Value that indicates suppression mechanism to use for content values (elements of array), if any; null for no filtering.
      Since:
      3.1

    • _suppressNulls

      protected final boolean _suppressNulls
      Flag that indicates whether nulls should be suppressed.
      Since:
      3.1

  • Constructor Details

  • Method Details

    • _withResolved

      protected abstract ArraySerializerBase<T> _withResolved(BeanProperty prop, Boolean unwrapSingle, Object suppressableValue, boolean suppressNulls)
      Factory method to use for creating differently configured instances with content inclusion settings, called by this class from createContextual(tools.jackson.databind.SerializationContext, tools.jackson.databind.BeanProperty).
      Since:
      3.1

    • createContextual

      public ValueSerializer<?> createContextual(SerializationContext ctxt, 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<T>
      Parameters:
      ctxt - 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.

    • serializeWithType

      public void serializeWithType(T value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws tools.jackson.core.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, ctxt);
  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<T>
      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:
      tools.jackson.core.JacksonException

    • serializeContents

      protected abstract void serializeContents(T value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt) throws tools.jackson.core.JacksonException
      Throws:
      tools.jackson.core.JacksonException

    • _shouldUnwrapSingle

      protected final boolean _shouldUnwrapSingle(SerializationContext ctxt)

    • _needToCheckFiltering

      protected boolean _needToCheckFiltering(SerializationContext ctxt)
      Common utility method for checking if this serializer needs to consider filtering of its elements. Returns true if filtering needs to be checked, false if not.
      Since:
      3.1

    • _shouldSerializeElement

      protected boolean _shouldSerializeElement(SerializationContext ctxt, Object elem)
      Common utility method for checking if an element should be filtered/suppressed based on @JsonInclude settings. Returns true if element should be serialized, false if it should be skipped.
      Parameters:
      ctxt - Serialization context
      elem - Element to check for suppression (boxed primitive)
      Returns:
      true if element should be serialized, false if suppressed
      Since:
      3.1