public abstract class AsArraySerializerBase<T> extends ContainerSerializer<T> implements ContextualSerializer
Collection
and array types.JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
protected PropertySerializerMap |
_dynamicSerializers
If element type cannot 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 Boolean |
_unwrapSingle
Setting for specific local override for "unwrap single element arrays":
true for enable unwrapping, false for preventing it, `null` for using
global configuration.
|
protected TypeSerializer |
_valueTypeSerializer
Type serializer used for values, if any.
|
_handledType
Modifier | Constructor and Description |
---|---|
protected |
AsArraySerializerBase(AsArraySerializerBase<?> src,
BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> elementSerializer)
Deprecated.
since 2.6: use the overloaded method that takes 'unwrapSingle'
|
protected |
AsArraySerializerBase(AsArraySerializerBase<?> src,
BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> elementSerializer,
Boolean unwrapSingle) |
protected |
AsArraySerializerBase(Class<?> cls,
JavaType et,
boolean staticTyping,
TypeSerializer vts,
BeanProperty property,
JsonSerializer<Object> elementSerializer)
Deprecated.
Since 2.6 Use variants that either take 'src', or do NOT pass
BeanProperty
|
protected |
AsArraySerializerBase(Class<?> cls,
JavaType et,
boolean staticTyping,
TypeSerializer vts,
JsonSerializer<Object> elementSerializer)
Non-contextual, "blueprint" constructor typically called when the first
instance is created, without knowledge of property it was used via.
|
Modifier and Type | Method and Description |
---|---|
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
Class<?> type,
SerializerProvider provider) |
protected JsonSerializer<Object> |
_findAndAddDynamic(PropertySerializerMap map,
JavaType type,
SerializerProvider provider) |
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format.
|
JsonSerializer<?> |
createContextual(SerializerProvider serializers,
BeanProperty property)
This method is needed to resolve contextual annotations like
per-property overrides, as well as do recursive call
to
createContextual of content serializer, if
known statically. |
JsonSerializer<?> |
getContentSerializer()
Accessor for serializer used for serializing contents
(List and array elements, Map values etc) of the
container for which this serializer is used, if it is
known statically.
|
JavaType |
getContentType()
Accessor for finding declared (static) element type for
type this serializer is used for.
|
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Default implementation simply claims type is "string"; usually
overriden by custom serializers.
|
void |
serialize(T value,
JsonGenerator gen,
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 gen,
SerializerProvider provider) |
void |
serializeWithType(T value,
JsonGenerator g,
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.
|
AsArraySerializerBase<T> |
withResolved(BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> elementSerializer)
Deprecated.
since 2.6: use the overloaded method that takes 'unwrapSingle'
|
abstract AsArraySerializerBase<T> |
withResolved(BeanProperty property,
TypeSerializer vts,
JsonSerializer<?> elementSerializer,
Boolean unwrapSingle) |
_withValueTypeSerializer, hasContentTypeAnnotation, hasSingleElement, withValueTypeSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
protected final JavaType _elementType
protected final BeanProperty _property
protected final boolean _staticTyping
protected final Boolean _unwrapSingle
protected final TypeSerializer _valueTypeSerializer
protected final JsonSerializer<Object> _elementSerializer
protected PropertySerializerMap _dynamicSerializers
protected AsArraySerializerBase(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> elementSerializer)
@Deprecated protected AsArraySerializerBase(Class<?> cls, JavaType et, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<Object> elementSerializer)
protected AsArraySerializerBase(AsArraySerializerBase<?> src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle)
@Deprecated protected AsArraySerializerBase(AsArraySerializerBase<?> src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer)
@Deprecated public final AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer)
public abstract AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle)
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException
createContextual
of content serializer, if
known statically.createContextual
in interface ContextualSerializer
serializers
- Serializer provider to use for accessing config, other serializersproperty
- Method or field that represents the property
(and is used to access value to serialize).
Should be available; but there may be cases where caller cannot provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)JsonMappingException
public JavaType getContentType()
ContainerSerializer
getContentType
in class ContainerSerializer<T>
public JsonSerializer<?> getContentSerializer()
ContainerSerializer
ContainerSerializer.getContentType()
and
SerializerProvider.findValueSerializer(java.lang.Class<?>, com.fasterxml.jackson.databind.BeanProperty)
.getContentSerializer
in class ContainerSerializer<T>
public void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException
JsonSerializer
serialize
in class StdSerializer<T>
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.IOException
public void serializeWithType(T value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException
JsonSerializer
Default implementation will throw UnsupportedOperationException
to indicate that proper type handling needs to be implemented.
For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:
// note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);and implementations for type serialized as JSON Arrays or Objects would differ slightly, as
START-ARRAY
/END-ARRAY
and
START-OBJECT
/END-OBJECT
pairs
need to be properly handled with respect to serializing of contents.serializeWithType
in class JsonSerializer<T>
value
- Value to serialize; can not be null.g
- 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 informationIOException
protected abstract void serializeContents(T value, JsonGenerator gen, SerializerProvider provider) throws IOException
IOException
public JsonNode getSchema(SerializerProvider provider, Type typeHint) throws JsonMappingException
StdSerializer
getSchema
in interface SchemaAware
getSchema
in class StdSerializer<T>
provider
- The serializer provider.typeHint
- A hint about the type.JsonMappingException
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
StdSerializer
acceptJsonFormatVisitor
in interface JsonFormatVisitable
acceptJsonFormatVisitor
in class StdSerializer<T>
typeHint
- Type of element (entity like property) being visitedJsonMappingException
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException
JsonMappingException
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException
JsonMappingException
Copyright © 2018 JBoss by Red Hat. All rights reserved.