org.codehaus.jackson.map.ser.std
Class AsArraySerializerBase<T>

java.lang.Object
  extended by org.codehaus.jackson.map.JsonSerializer<T>
      extended by org.codehaus.jackson.map.ser.std.SerializerBase<T>
          extended by org.codehaus.jackson.map.ser.std.ContainerSerializerBase<T>
              extended by org.codehaus.jackson.map.ser.std.AsArraySerializerBase<T>
All Implemented Interfaces:
ResolvableSerializer, SchemaAware
Direct Known Subclasses:
CollectionSerializer, EnumSetSerializer, IterableSerializer, StdContainerSerializers.IndexedListSerializer, StdContainerSerializers.IteratorSerializer

public abstract class AsArraySerializerBase<T>
extends ContainerSerializerBase<T>
implements ResolvableSerializer

Base class for serializers that will output contents as JSON arrays; typically serializers used for Collection and array types.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer
JsonSerializer.None
 
Field Summary
protected  PropertySerializerMap _dynamicSerializers
          If element type can not be statically determined, mapping from runtime type to serializer is handled using this object
protected  JsonSerializer<Object> _elementSerializer
          Value serializer to use, if it can be statically determined
protected  JavaType _elementType
           
protected  BeanProperty _property
          Collection-valued property being serialized with this instance
protected  boolean _staticTyping
           
protected  TypeSerializer _valueTypeSerializer
          Type serializer used for values, if any.
 
Fields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
_handledType
 
Constructor Summary
protected AsArraySerializerBase(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, BeanProperty property)
          Deprecated. since 1.8
protected AsArraySerializerBase(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<Object> elementSerializer)
           
 
Method Summary
protected  JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider)
           
protected  JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
           
 JsonNode getSchema(SerializerProvider provider, Type typeHint)
          Note: since Jackson 1.9, default implementation claims type is "string"
 void resolve(SerializerProvider provider)
          Need to get callback to resolve value serializer, if static typing is used (either being forced, or because value type is final)
 void serialize(T value, JsonGenerator jgen, SerializerProvider provider)
          Method that can be called to ask implementation to serialize values of type this serializer handles.
protected abstract  void serializeContents(T value, JsonGenerator jgen, SerializerProvider provider)
           
 void serializeWithType(T value, JsonGenerator jgen, SerializerProvider provider, 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 org.codehaus.jackson.map.ser.std.ContainerSerializerBase
_withValueTypeSerializer, withValueTypeSerializer
 
Methods inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow
 
Methods inherited from class org.codehaus.jackson.map.JsonSerializer
isUnwrappingSerializer, unwrappingSerializer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_staticTyping

protected final boolean _staticTyping

_elementType

protected final JavaType _elementType

_valueTypeSerializer

protected final TypeSerializer _valueTypeSerializer
Type serializer used for values, if any.


_elementSerializer

protected JsonSerializer<Object> _elementSerializer
Value serializer to use, if it can be statically determined

Since:
1.5

_property

protected final BeanProperty _property
Collection-valued property being serialized with this instance

Since:
1.7

_dynamicSerializers

protected PropertySerializerMap _dynamicSerializers
If element type can not be statically determined, mapping from runtime type to serializer is handled using this object

Since:
1.7
Constructor Detail

AsArraySerializerBase

@Deprecated
protected AsArraySerializerBase(Class<?> cls,
                                           JavaType et,
                                           boolean staticTyping,
                                           TypeSerializer vts,
                                           BeanProperty property)
Deprecated. since 1.8


AsArraySerializerBase

protected AsArraySerializerBase(Class<?> cls,
                                JavaType et,
                                boolean staticTyping,
                                TypeSerializer vts,
                                BeanProperty property,
                                JsonSerializer<Object> elementSerializer)
Method Detail

serialize

public final void serialize(T value,
                            JsonGenerator jgen,
                            SerializerProvider provider)
                     throws IOException,
                            JsonGenerationException
Description copied from class: JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.

Specified by:
serialize in class SerializerBase<T>
Parameters:
value - Value to serialize; can not be null.
jgen - Generator used to output resulting Json content
provider - Provider that can be used to get serializers for serializing Objects value contains, if any.
Throws:
IOException
JsonGenerationException

serializeWithType

public final void serializeWithType(T value,
                                    JsonGenerator jgen,
                                    SerializerProvider provider,
                                    TypeSerializer typeSer)
                             throws IOException,
                                    JsonGenerationException
Description copied from class: JsonSerializer
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 ignore serialization of type information, and just calls JsonSerializer.serialize(T, org.codehaus.jackson.JsonGenerator, org.codehaus.jackson.map.SerializerProvider): serializers that can embed type information should override this to implement actual handling. Most common such handling is done by something like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, jgen);
  serialize(value, jgen, provider);
  typeSer.writeTypeSuffixForScalar(value, jgen);

Overrides:
serializeWithType in class JsonSerializer<T>
Parameters:
value - Value to serialize; can not be null.
jgen - Generator used to output resulting Json content
provider - Provider that can be used to get serializers for serializing Objects value contains, if any.
typeSer - Type serializer to use for including type information
Throws:
IOException
JsonGenerationException

serializeContents

protected abstract void serializeContents(T value,
                                          JsonGenerator jgen,
                                          SerializerProvider provider)
                                   throws IOException,
                                          JsonGenerationException
Throws:
IOException
JsonGenerationException

getSchema

public JsonNode getSchema(SerializerProvider provider,
                          Type typeHint)
                   throws JsonMappingException
Description copied from class: SerializerBase
Note: since Jackson 1.9, default implementation claims type is "string"

Specified by:
getSchema in interface SchemaAware
Overrides:
getSchema in class SerializerBase<T>
Parameters:
provider - The serializer provider.
typeHint - A hint about the type.
Returns:
Json-schema for this serializer.
Throws:
JsonMappingException

resolve

public void resolve(SerializerProvider provider)
             throws JsonMappingException
Need to get callback to resolve value serializer, if static typing is used (either being forced, or because value type is final)

Specified by:
resolve in interface ResolvableSerializer
Parameters:
provider - Provider that has constructed serializer this method is called on.
Throws:
JsonMappingException

_findAndAddDynamic

protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map,
                                                          Class<?> type,
                                                          SerializerProvider provider)
                                                   throws JsonMappingException
Throws:
JsonMappingException
Since:
1.7

_findAndAddDynamic

protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map,
                                                          JavaType type,
                                                          SerializerProvider provider)
                                                   throws JsonMappingException
Throws:
JsonMappingException
Since:
1.8