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

Class AsArraySerializerBase<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.AsArraySerializerBase<T>
All Implemented Interfaces:
JsonFormatVisitable
Direct Known Subclasses:
CollectionSerializer, EnumSetSerializer, IndexedListSerializer, IterableSerializer, IteratorSerializer
public abstract class AsArraySerializerBase<T> extends StdContainerSerializer<T>
Base class for serializers that will output contents as JSON arrays; typically serializers used for Collection and array types.

  • Field Details

    • _elementType

      protected final JavaType _elementType

    • _staticTyping

      protected final boolean _staticTyping

    • MARKER_FOR_EMPTY

      protected static final Object MARKER_FOR_EMPTY

    • _suppressableValue

      protected final Object _suppressableValue
      Value that indicates suppression mechanism to use for content values (elements of container), 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

    • _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.

    • _valueTypeSerializer

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

    • _elementSerializer

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

  • Constructor Details

  • Method Details

    • withResolved

      @Deprecated protected AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle)
      Deprecated.
      Since 3.1, callers should switch to calling withResolved(BeanProperty, TypeSerializer, ValueSerializer, Boolean, Object, boolean) instead.

      NOTE: non-abstract in 3.1, to avoid sub-class from having to implement it; calls withResolved(BeanProperty, TypeSerializer, ValueSerializer, Boolean, Object, boolean).

    • withResolved

      protected AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle, Object suppressableValue, boolean suppressNulls)
      Factory method to use for creating differently configured instances, called by this class (from #createContextual), overridden by implementation class.

      NOTE: only implemented for backwards-compatibility with 3.0 version JacksonModules, otherwise would be abstract: sub-classes really need to override.

      Since:
      3.1

    • createContextual

      public ValueSerializer<?> createContextual(SerializationContext ctxt, BeanProperty property)
      This method is needed to resolve contextual annotations like per-property overrides, as well as do recursive call to createContextual of content serializer, if known statically.
      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.

    • 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<T>

    • 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<T>

    • 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

    • acceptJsonFormatVisitor

      public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws tools.jackson.core.JacksonException
      Description copied from class: StdSerializer
      Default implementation specifies no format. This behavior is usually overriden by custom serializers.
      Specified by:
      acceptJsonFormatVisitor in interface JsonFormatVisitable
      Overrides:
      acceptJsonFormatVisitor in class StdSerializer<T>
      typeHint - Type of element (entity like property) being visited
      Throws:
      tools.jackson.core.JacksonException

    • _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, ValueSerializer<Object> serializer)
      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
      serializer - Serializer for the element (may be null for strings)
      Returns:
      true if element should be serialized, false if suppressed
      Since:
      3.1