com.fasterxml.jackson.databind.ser.std
Class CollectionSerializer

java.lang.Object
  extended by com.fasterxml.jackson.databind.JsonSerializer<T>
      extended by com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
          extended by com.fasterxml.jackson.databind.ser.ContainerSerializer<T>
              extended by com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase<Collection<?>>
                  extended by com.fasterxml.jackson.databind.ser.std.CollectionSerializer
All Implemented Interfaces:
SchemaAware, ContextualSerializer

public class CollectionSerializer
extends AsArraySerializerBase<Collection<?>>

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 Iterator to iterate over elements.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
 
Field Summary
 
Fields inherited from class com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase
_dynamicSerializers, _elementSerializer, _elementType, _property, _staticTyping, _valueTypeSerializer
 
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
 
Constructor Summary
CollectionSerializer(CollectionSerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> valueSerializer)
           
CollectionSerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<Object> valueSerializer)
           
 
Method Summary
 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(Collection<?> value)
          Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
 boolean isEmpty(Collection<?> value)
          Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
 void serializeContents(Collection<?> value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider)
           
 void serializeContentsUsing(Collection<?> value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser)
           
 CollectionSerializer withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer)
           
 
Methods inherited from class com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase
_findAndAddDynamic, _findAndAddDynamic, createContextual, getContentSerializer, getContentType, getSchema, serialize, serializeWithType
 
Methods inherited from class com.fasterxml.jackson.databind.ser.ContainerSerializer
withValueTypeSerializer
 
Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow
 
Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer
isUnwrappingSerializer, unwrappingSerializer, usesObjectId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CollectionSerializer

public CollectionSerializer(JavaType elemType,
                            boolean staticTyping,
                            TypeSerializer vts,
                            BeanProperty property,
                            JsonSerializer<Object> valueSerializer)

CollectionSerializer

public CollectionSerializer(CollectionSerializer src,
                            BeanProperty property,
                            TypeSerializer vts,
                            JsonSerializer<?> valueSerializer)
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.

Specified by:
_withValueTypeSerializer in class ContainerSerializer<Collection<?>>

withResolved

public CollectionSerializer withResolved(BeanProperty property,
                                         TypeSerializer vts,
                                         JsonSerializer<?> elementSerializer)
Specified by:
withResolved in class AsArraySerializerBase<Collection<?>>

isEmpty

public boolean isEmpty(Collection<?> 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.

Specified by:
isEmpty in class ContainerSerializer<Collection<?>>

hasSingleElement

public boolean hasSingleElement(Collection<?> 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).

Specified by:
hasSingleElement in class ContainerSerializer<Collection<?>>

serializeContents

public void serializeContents(Collection<?> value,
                              com.fasterxml.jackson.core.JsonGenerator jgen,
                              SerializerProvider provider)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonGenerationException
Specified by:
serializeContents in class AsArraySerializerBase<Collection<?>>
Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException

serializeContentsUsing

public void serializeContentsUsing(Collection<?> value,
                                   com.fasterxml.jackson.core.JsonGenerator jgen,
                                   SerializerProvider provider,
                                   JsonSerializer<Object> ser)
                            throws IOException,
                                   com.fasterxml.jackson.core.JsonGenerationException
Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException


Copyright © 2012 fasterxml.com. All Rights Reserved.