Module tools.jackson.databind

Package tools.jackson.databind.ser.jdk

Class IterableSerializer

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.AsArraySerializerBase<Iterable<?>>

tools.jackson.databind.ser.jdk.IterableSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class IterableSerializer
extends AsArraySerializerBase<Iterable<?>>

Nested Class Summary

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

ValueSerializer.None

Field Summary

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

_elementSerializer, _elementType, _staticTyping, _unwrapSingle, _valueTypeSerializer

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

_dynamicValueSerializers, _property

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

_handledType

Constructor Summary

Constructors

Constructor	Description
IterableSerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts)
IterableSerializer(IterableSerializer src, TypeSerializer vts, ValueSerializer<?> valueSerializer, Boolean unwrapSingle, BeanProperty property)

Method Summary

Modifier and Type	Method	Description
protected StdContainerSerializer<?>	_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(Iterable<?> value)	Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
boolean	isEmpty(SerializationContext prov, Iterable<?> value)	Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
final void	serialize(Iterable<?> value, JsonGenerator g, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeContents(Iterable<?> value, JsonGenerator g, SerializationContext ctxt)
IterableSerializer	withResolved(BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle)

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

acceptJsonFormatVisitor, createContextual, getContentSerializer, getContentType, serializeWithType

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

_findAndAddDynamic, _findAndAddDynamic, withValueTypeSerializer

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

Constructor Details

IterableSerializer

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

IterableSerializer

public IterableSerializer(IterableSerializer src,
 TypeSerializer vts,
 ValueSerializer<?> valueSerializer,
 Boolean unwrapSingle,
 BeanProperty property)

Method Details

_withValueTypeSerializer

protected StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Description copied from class: StdContainerSerializer

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.

Specified by:

_withValueTypeSerializer in class StdContainerSerializer<Iterable<?>>

withResolved

public IterableSerializer withResolved(BeanProperty property,
 TypeSerializer vts,
 ValueSerializer<?> elementSerializer,
 Boolean unwrapSingle)

Specified by:

withResolved in class AsArraySerializerBase<Iterable<?>>

isEmpty

public boolean isEmpty(SerializationContext prov,
 Iterable<?> 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<Iterable<?>>

hasSingleElement

public boolean hasSingleElement(Iterable<?> 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<Iterable<?>>

serialize

public final void serialize(Iterable<?> value,
 JsonGenerator g,
 SerializationContext ctxt)
                     throws 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<Iterable<?>>

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:

JacksonException

serializeContents

public void serializeContents(Iterable<?> value,
 JsonGenerator g,
 SerializationContext ctxt)
                       throws JacksonException

Specified by:

serializeContents in class AsArraySerializerBase<Iterable<?>>

Throws:

JacksonException