com.fasterxml.jackson.databind.ser.std

Class IterableSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<T>

com.fasterxml.jackson.databind.ser.ContainerSerializer<T>

com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase<java.lang.Iterable<?>>

com.fasterxml.jackson.databind.ser.std.IterableSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, java.io.Serializable

public class IterableSerializer
extends AsArraySerializerBase<java.lang.Iterable<?>>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

JsonSerializer.None

Constructor Summary

Constructors

Constructor and Description
IterableSerializer(IterableSerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> valueSerializer, java.lang.Boolean unwrapSingle)
IterableSerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts)

Method Summary

Modifier and Type	Method and Description
ContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) 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.
boolean	hasSingleElement(java.lang.Iterable<?> value) Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
boolean	isEmpty(SerializerProvider prov, java.lang.Iterable<?> value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(java.lang.Iterable<?> value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeContents(java.lang.Iterable<?> value, JsonGenerator jgen, SerializerProvider provider)
IterableSerializer	withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, java.lang.Boolean unwrapSingle)

Methods inherited from class com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase

acceptJsonFormatVisitor, createContextual, getContentSerializer, getContentType, getSchema, serializeWithType, withResolved

Methods inherited from class com.fasterxml.jackson.databind.ser.ContainerSerializer

withValueTypeSerializer

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

getSchema, handledType, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId

Methods inherited from class java.lang.Object

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

Constructor Detail

IterableSerializer

public IterableSerializer(JavaType elemType,
                          boolean staticTyping,
                          TypeSerializer vts)

IterableSerializer

public IterableSerializer(IterableSerializer src,
                          BeanProperty property,
                          TypeSerializer vts,
                          JsonSerializer<?> valueSerializer,
                          java.lang.Boolean unwrapSingle)

Method Detail

_withValueTypeSerializer

public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Description copied from class: ContainerSerializer

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.

withResolved

public IterableSerializer withResolved(BeanProperty property,
                                       TypeSerializer vts,
                                       JsonSerializer<?> elementSerializer,
                                       java.lang.Boolean unwrapSingle)

Specified by:

withResolved in class AsArraySerializerBase<java.lang.Iterable<?>>

isEmpty

public boolean isEmpty(SerializerProvider prov,
                       java.lang.Iterable<?> value)

Description copied from class: JsonSerializer

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.

NOTE: replaces JsonSerializer.isEmpty(Object), which was deprecated in 2.5

Overrides:

isEmpty in class JsonSerializer<java.lang.Iterable<?>>

hasSingleElement

public boolean hasSingleElement(java.lang.Iterable<?> value)

Description copied from class: ContainerSerializer

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 as of now (2.9) 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 ContainerSerializer<java.lang.Iterable<?>>

serialize

public final void serialize(java.lang.Iterable<?> value,
                            JsonGenerator gen,
                            SerializerProvider provider)
                     throws java.io.IOException

Description copied from class: JsonSerializer

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

Overrides:

serialize in class AsArraySerializerBase<java.lang.Iterable<?>>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

provider - Provider that can be used to get serializers for serializing Objects value contains, if any.

Throws:

java.io.IOException

serializeContents

public void serializeContents(java.lang.Iterable<?> value,
                              JsonGenerator jgen,
                              SerializerProvider provider)
                       throws java.io.IOException

Throws:

java.io.IOException