Package org.codehaus.jackson.map.ser.std
Class AsArraySerializerBase<T>
java.lang.Object
org.codehaus.jackson.map.JsonSerializer<T>
org.codehaus.jackson.map.ser.std.SerializerBase<T>
org.codehaus.jackson.map.ser.std.ContainerSerializerBase<T>
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
FieldsModifier and TypeFieldDescriptionprotected PropertySerializerMap
If element type can not be statically determined, mapping from runtime type to serializer is handled using this objectprotected JsonSerializer<Object>
Value serializer to use, if it can be statically determinedprotected final JavaType
protected final BeanProperty
Collection-valued property being serialized with this instanceprotected final boolean
protected final TypeSerializer
Type serializer used for values, if any.Fields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
_handledType
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AsArraySerializerBase
(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, BeanProperty property) Deprecated.since 1.8protected
AsArraySerializerBase
(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<Object> elementSerializer) -
Method Summary
Modifier and TypeMethodDescriptionprotected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, Class<?> type, SerializerProvider provider) protected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, JavaType type, SerializerProvider provider) 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)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) final 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
-
Field Details
-
_staticTyping
protected final boolean _staticTyping -
_elementType
-
_valueTypeSerializer
Type serializer used for values, if any. -
_elementSerializer
Value serializer to use, if it can be statically determined- Since:
- 1.5
-
_property
Collection-valued property being serialized with this instance- Since:
- 1.7
-
_dynamicSerializers
If element type can not be statically determined, mapping from runtime type to serializer is handled using this object- Since:
- 1.7
-
-
Constructor Details
-
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 Details
-
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 classSerializerBase<T>
- Parameters:
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- 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 classJsonSerializer<T>
- Parameters:
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- 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
Description copied from class:SerializerBase
Note: since Jackson 1.9, default implementation claims type is "string"- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classSerializerBase<T>
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-
resolve
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 interfaceResolvableSerializer
- 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
-