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

Class StringArraySerializer

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<String[]>
tools.jackson.databind.ser.jdk.StringArraySerializer
All Implemented Interfaces:
JsonFormatVisitable
public class StringArraySerializer extends ArraySerializerBase<String[]>
Standard serializer used for String[] values.

  • Field Details

    • instance

      public static final StringArraySerializer instance

    • _elementSerializer

      protected final ValueSerializer<Object> _elementSerializer
      Value serializer to use, if it's not the standard one (if it is we can optimize serialization significantly)

  • Constructor Details

  • Method Details

    • _withResolved

      public ValueSerializer<?> _withResolved(BeanProperty prop, Boolean unwrapSingle)
      Specified by:
      _withResolved in class ArraySerializerBase<String[]>

    • _withValueTypeSerializer

      public StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)
      Strings never add type info; hence, even if type serializer is suggested, we'll ignore it...
      Specified by:
      _withValueTypeSerializer in class StdContainerSerializer<String[]>

    • 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 ArraySerializerBase<String[]>
      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<String[]>

    • 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<String[]>

    • isEmpty

      public boolean isEmpty(SerializationContext prov, String[] value)
      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<String[]>

    • hasSingleElement

      public boolean hasSingleElement(String[] 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<String[]>

    • serialize

      public final void serialize(String[] value, tools.jackson.core.JsonGenerator gen, SerializationContext provider) 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.
      Specified by:
      serialize in class StdSerializer<String[]>
      Parameters:
      value - 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

    • serializeContents

      public void serializeContents(String[] value, tools.jackson.core.JsonGenerator gen, SerializationContext provider) throws tools.jackson.core.JacksonException
      Specified by:
      serializeContents in class ArraySerializerBase<String[]>
      Throws:
      tools.jackson.core.JacksonException

    • acceptJsonFormatVisitor

      public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
      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<String[]>
      typeHint - Type of element (entity like property) being visited