Top Description Fields Constructors Methods
tools.jackson.databind.ser.jdk

public Class CollectionSerializer

extends AsArraySerializerBase<Collection<?>>
Class Inheritance
Imports
java.util.Collection, .EnumSet, .Iterator, tools.jackson.core.*, tools.jackson.databind.BeanProperty, .JavaType, .SerializationFeature, .SerializationContext, .ValueSerializer, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.ser.impl.PropertySerializerMap, tools.jackson.databind.ser.std.AsArraySerializerBase, .StdContainerSerializer

Fallback serializer for cases where Collection is not known to be of type for which more specializer serializer exists (such as index-accessible List). If so, we will just construct an java.util.Iterator to iterate over elements.

Field Summary

Modifier and TypeField and Description
private final boolean
_maybeEnumSet

Flag that indicates that we may need to check for EnumSet dynamically during serialization: problem being that we can't always do it statically.

Inherited from tools.jackson.databind.ser.std.AsArraySerializerBase:
_elementSerializer_elementType_staticTyping_unwrapSingle_valueTypeSerializer

Constructor Summary

AccessConstructor and Description
public
CollectionSerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, ValueSerializer<Object> valueSerializer)

protected
CollectionSerializer(CollectionSerializer src, TypeSerializer vts, ValueSerializer<?> valueSerializer, Boolean unwrapSingle, BeanProperty property)

Method Summary

Modifier and TypeMethod and Description
protected StdContainerSerializer<?>
_withValueTypeSerializer(TypeSerializer vts)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.

public boolean
hasSingleElement(Collection<?> value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

Method called to determine if the given value (of type handled by this serializer) contains exactly one element.

public boolean
isEmpty(SerializationContext prov, Collection<?> value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty.

Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

public final void
serialize(Collection<?> value, JsonGenerator g, SerializationContext provider)

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

public void
public void
protected CollectionSerializer
Inherited from tools.jackson.databind.ser.std.AsArraySerializerBase:
acceptJsonFormatVisitorcreateContextualgetContentSerializergetContentTypeserializeWithType

Field Detail

_maybeEnumSetback to summary
private final boolean _maybeEnumSet

Flag that indicates that we may need to check for EnumSet dynamically during serialization: problem being that we can't always do it statically. But we can figure out when there is a possibility wrt type signature we get.

Constructor Detail

CollectionSerializerback to summary
public CollectionSerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, ValueSerializer<Object> valueSerializer)
CollectionSerializerback to summary
protected CollectionSerializer(CollectionSerializer src, TypeSerializer vts, ValueSerializer<?> valueSerializer, Boolean unwrapSingle, BeanProperty property)

Method Detail

_withValueTypeSerializerback to summary
protected StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.

Annotations
@Override
hasSingleElementback to summary
public boolean hasSingleElement(Collection<?> value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

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.

Annotations
@Override
isEmptyback to summary
public boolean isEmpty(SerializationContext prov, Collection<?> value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty.

Doc from tools.jackson.databind.ValueSerializer.isEmpty.

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.

Annotations
@Override
serializeback to summary
public final void serialize(Collection<?> value, JsonGenerator g, SerializationContext provider) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

Doc from tools.jackson.databind.ValueSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Annotations
@Override
serializeContentsback to summary
public void serializeContents(Collection<?> value, JsonGenerator g, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.AsArraySerializerBase.serializeContents.

Annotations
@Override
serializeContentsUsingback to summary
public void serializeContentsUsing(Collection<?> value, JsonGenerator g, SerializationContext provider, ValueSerializer<Object> ser) throws JacksonException
withResolvedback to summary
protected CollectionSerializer withResolved(BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle)

Implements abstract tools.jackson.databind.ser.std.AsArraySerializerBase.withResolved.

Annotations
@Override