Module tools.jackson.databind
Package tools.jackson.databind.ser.bean

Class BeanAsArraySerializer

java.lang.Object
tools.jackson.databind.ValueSerializer<T>
tools.jackson.databind.ser.std.StdSerializer<Object>
tools.jackson.databind.ser.bean.BeanSerializerBase
tools.jackson.databind.ser.bean.BeanAsArraySerializer
All Implemented Interfaces:
JsonFormatVisitable
public class BeanAsArraySerializer extends BeanSerializerBase
Specialized POJO serializer that differs from BeanSerializer in that instead of producing a JSON Object it will output a JSON Array, omitting field names, and serializing values in specified serialization order. This behavior is usually triggered by using annotation JsonFormat or its equivalents.

This serializer can be used for "simple" instances; and will NOT be used if one of following is true:

  • Unwrapping is used (no way to expand out array in JSON Object)
  • Type information ("type id") is to be used: while this could work for some embedding methods, it would likely cause conflicts.
  • Object Identity ("object id") is used: while references would work, the problem is inclusion of id itself.
Note that it is theoretically possible that last 2 issues could be addressed (by reserving room in array, for example); and if so, support improved.

In cases where array-based output is not feasible, this serializer can instead delegate to the original Object-based serializer; this is why a reference is retained to the original serializer.

  • Field Details

    • _defaultSerializer

      protected final BeanSerializerBase _defaultSerializer
      Serializer that would produce JSON Object version; used in cases where array output cannot be used.

  • Constructor Details

  • Method Details

    • construct

      public static BeanSerializerBase construct(BeanSerializerBase src)
      Since:
      3.0

    • unwrappingSerializer

      public ValueSerializer<Object> unwrappingSerializer(NameTransformer transformer)
      Description copied from class: BeanSerializerBase
      Lets force sub-classes to implement this, to avoid accidental missing of handling...
      Specified by:
      unwrappingSerializer in class BeanSerializerBase
      Parameters:
      transformer - Name transformation to use to convert between names of unwrapper properties

    • isUnwrappingSerializer

      public boolean isUnwrappingSerializer()
      Description copied from class: ValueSerializer
      Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.
      Overrides:
      isUnwrappingSerializer in class ValueSerializer<Object>

    • withObjectIdWriter

      public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)
      Description copied from class: BeanSerializerBase
      Mutant factory used for creating a new instance with different ObjectIdWriter.
      Specified by:
      withObjectIdWriter in class BeanSerializerBase

    • withFilterId

      public BeanSerializerBase withFilterId(Object filterId)
      Description copied from class: BeanSerializerBase
      Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)
      Specified by:
      withFilterId in class BeanSerializerBase

    • withByNameInclusion

      protected BeanAsArraySerializer withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)
      Description copied from class: BeanSerializerBase
      Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)
      Specified by:
      withByNameInclusion in class BeanSerializerBase

    • withProperties

      protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
      Description copied from class: BeanSerializerBase
      Mutant factory used for creating a new instance with modified set of properties
      Specified by:
      withProperties in class BeanSerializerBase

    • asArraySerializer

      protected BeanSerializerBase asArraySerializer()
      Description copied from class: BeanSerializerBase
      Mutant factory for creating a variant that output POJO as a JSON Array. Implementations may ignore this request if output as array is not possible (either at all, or reliably).
      Specified by:
      asArraySerializer in class BeanSerializerBase

    • serializeWithType

      public void serializeWithType(Object bean, tools.jackson.core.JsonGenerator gen, 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, 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 BeanSerializerBase
      Parameters:
      bean - Value to serialize; can not be null.
      gen - 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

    • serialize

      public final void serialize(Object bean, tools.jackson.core.JsonGenerator gen, SerializationContext provider) throws tools.jackson.core.JacksonException
      Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.
      Specified by:
      serialize in class BeanSerializerBase
      Parameters:
      bean - Value to serialize; can not be null.
      gen - Generator used to output resulting Json content
      provider - Context that can be used to get serializers for serializing Objects value contains, if any.
      Throws:
      tools.jackson.core.JacksonException

    • serializeNonFiltered

      protected final void serializeNonFiltered(Object bean, tools.jackson.core.JsonGenerator gen, SerializationContext provider) throws tools.jackson.core.JacksonException
      Throws:
      tools.jackson.core.JacksonException

    • serializeFiltered

      protected final void serializeFiltered(Object bean, tools.jackson.core.JsonGenerator gen, SerializationContext provider) throws tools.jackson.core.JacksonException
      Throws:
      tools.jackson.core.JacksonException