Module tools.jackson.databind

Package tools.jackson.databind.ser.jdk

Class StringCollectionSerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<T>

tools.jackson.databind.ser.std.StdSerializer<T>

tools.jackson.databind.ser.jdk.StaticListSerializerBase<Collection<String>>

tools.jackson.databind.ser.jdk.StringCollectionSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class StringCollectionSerializer
extends StaticListSerializerBase<Collection<String>>

Efficient implement for serializing Collections that contain Strings. The only complexity is due to possibility that serializer for String may be override; because of this, logic is needed to ensure that the default serializer is in use to use fastest mode, or if not, to defer to custom String serializer.

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueSerializer

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static final StringCollectionSerializer	instance

Fields inherited from class tools.jackson.databind.ser.jdk.StaticListSerializerBase

_rawElementType, _suppressableValue, _suppressNulls, _unwrapSingle, MARKER_FOR_EMPTY

Fields inherited from class tools.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringCollectionSerializer()
protected	StringCollectionSerializer(StringCollectionSerializer src, Boolean unwrapSingle)	Deprecated.
protected	StringCollectionSerializer(StringCollectionSerializer src, Boolean unwrapSingle, Object suppressableValue, boolean suppressNulls)

Method Summary

Modifier and Type	Method	Description
ValueSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle)	Deprecated.
ValueSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle, Object suppressableValue, boolean suppressNulls)	To support `@JsonInclude`.
protected void	acceptContentVisitor(JsonArrayFormatVisitor visitor)
protected JsonNode	contentSchema()
void	serialize(Collection<String> value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(Collection<String> value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer)	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.

Methods inherited from class tools.jackson.databind.ser.jdk.StaticListSerializerBase

_shouldSerializeElement, acceptJsonFormatVisitor, createContextual, isEmpty

Methods inherited from class tools.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, _wrapIOFailure, acceptJsonFormatVisitorForBinary, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class tools.jackson.databind.ValueSerializer

getDelegatee, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, withIgnoredProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

instance

public static final StringCollectionSerializer instance

Constructor Details

StringCollectionSerializer

protected StringCollectionSerializer()

StringCollectionSerializer

@Deprecated
protected StringCollectionSerializer(StringCollectionSerializer src,
 Boolean unwrapSingle)

Deprecated.

StringCollectionSerializer

protected StringCollectionSerializer(StringCollectionSerializer src,
 Boolean unwrapSingle,
 Object suppressableValue,
 boolean suppressNulls)

Since:

3.1

Method Details

_withResolved

@Deprecated
public ValueSerializer<?> _withResolved(BeanProperty prop,
 Boolean unwrapSingle)

Deprecated.

Specified by:

_withResolved in class StaticListSerializerBase<Collection<String>>

_withResolved

public ValueSerializer<?> _withResolved(BeanProperty prop,
 Boolean unwrapSingle,
 Object suppressableValue,
 boolean suppressNulls)

Description copied from class: StaticListSerializerBase

To support `@JsonInclude`. Default implementation fallback to StaticListSerializerBase._withResolved(BeanProperty, Boolean, Object, boolean)

Overrides:

_withResolved in class StaticListSerializerBase<Collection<String>>

contentSchema

protected JsonNode contentSchema()

Specified by:

contentSchema in class StaticListSerializerBase<Collection<String>>

acceptContentVisitor

protected void acceptContentVisitor(JsonArrayFormatVisitor visitor)

Specified by:

acceptContentVisitor in class StaticListSerializerBase<Collection<String>>

serialize

public void serialize(Collection<String> value,
 tools.jackson.core.JsonGenerator g,
 SerializationContext ctxt)
               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<Collection<String>>

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:

tools.jackson.core.JacksonException

serializeWithType

public void serializeWithType(Collection<String> 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.

Specified by:

serializeWithType in class StaticListSerializerBase<Collection<String>>

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