public class BeanAsArraySerializer extends BeanSerializerBase
BeanSerializer
in that instead of producing a JSON Object it will output
a JSON Array, omitting field names, and serializing values in
specified serialization order.
This behavior is usually triggered by using annotation
JsonFormat
or its
equivalents.
This serializer can be used for "simple" instances; and will NOT be used if one of following is true:
In cases where array-based output is not feasible, this serializer can instead delegate to the original Object-based serializer; this is why a reference is retained to the original serializer.
JsonSerializer.None
Modifier and Type | Field and Description |
---|---|
protected BeanSerializerBase |
_defaultSerializer
Serializer that would produce JSON Object version; used in
cases where array output cannot be used.
|
_anyGetterWriter, _beanType, _filteredProps, _objectIdWriter, _propertyFilterId, _props, _serializationShape, _typeId, NAME_FOR_OBJECT_REF, NO_PROPS
_handledType
Modifier | Constructor and Description |
---|---|
|
BeanAsArraySerializer(BeanSerializerBase src) |
protected |
BeanAsArraySerializer(BeanSerializerBase src,
ObjectIdWriter oiw,
Object filterId) |
protected |
BeanAsArraySerializer(BeanSerializerBase src,
Set<String> toIgnore) |
protected |
BeanAsArraySerializer(BeanSerializerBase src,
Set<String> toIgnore,
Set<String> toInclude) |
Modifier and Type | Method and Description |
---|---|
protected BeanSerializerBase |
asArraySerializer()
Mutant factory for creating a variant that output POJO as a
JSON Array.
|
boolean |
isUnwrappingSerializer()
Accessor for checking whether this serializer is an
"unwrapping" serializer; this is necessary to know since
it may also require caller to suppress writing of the
leading property name.
|
void |
serialize(Object bean,
JsonGenerator gen,
SerializerProvider provider)
Main serialization method that will delegate actual output to
configured
BeanPropertyWriter instances. |
protected void |
serializeAsArray(Object bean,
JsonGenerator gen,
SerializerProvider provider) |
void |
serializeWithType(Object bean,
JsonGenerator gen,
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.
|
String |
toString() |
JsonSerializer<Object> |
unwrappingSerializer(NameTransformer transformer)
Method that will return serializer instance that produces
"unwrapped" serialization, if applicable for type being
serialized (which is the case for some serializers
that produce JSON Objects as output).
|
protected BeanAsArraySerializer |
withByNameInclusion(Set<String> toIgnore,
Set<String> toInclude)
Mutant factory used for creating a new instance with additional
set of properties to ignore or include (from properties this instance otherwise has)
|
BeanSerializerBase |
withFilterId(Object filterId)
Mutant factory used for creating a new instance with different
filter id (used with
JsonFilter annotation) |
BeanSerializerBase |
withObjectIdWriter(ObjectIdWriter objectIdWriter)
Mutant factory used for creating a new instance with different
ObjectIdWriter . |
protected BeanSerializerBase |
withProperties(BeanPropertyWriter[] properties,
BeanPropertyWriter[] filteredProperties)
Mutant factory used for creating a new instance with modified set
of properties.
|
_customTypeId, _serializeObjectId, _serializeWithObjectId, _serializeWithObjectId, _typeIdDef, acceptJsonFormatVisitor, createContextual, findConvertingSerializer, getSchema, properties, resolve, serializeFields, serializeFieldsFiltered, usesObjectId, withIgnorals, withIgnorals
_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, replaceDelegatee
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getSchema
protected final BeanSerializerBase _defaultSerializer
public BeanAsArraySerializer(BeanSerializerBase src)
protected BeanAsArraySerializer(BeanSerializerBase src, Set<String> toIgnore)
protected BeanAsArraySerializer(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude)
protected BeanAsArraySerializer(BeanSerializerBase src, ObjectIdWriter oiw, Object filterId)
public JsonSerializer<Object> unwrappingSerializer(NameTransformer transformer)
JsonSerializer
Default implementation just returns serializer as-is, indicating that no unwrapped variant exists
unwrappingSerializer
in class JsonSerializer<Object>
transformer
- Name transformation to use to convert between names
of unwrapper propertiespublic boolean isUnwrappingSerializer()
JsonSerializer
isUnwrappingSerializer
in class JsonSerializer<Object>
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)
BeanSerializerBase
ObjectIdWriter
.withObjectIdWriter
in class BeanSerializerBase
public BeanSerializerBase withFilterId(Object filterId)
BeanSerializerBase
JsonFilter
annotation)withFilterId
in class BeanSerializerBase
protected BeanAsArraySerializer withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)
BeanSerializerBase
withByNameInclusion
in class BeanSerializerBase
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)
BeanSerializerBase
Note: in 2.11.x, need to keep non-abstract for slightly better compatibility (XML module extends)
withProperties
in class BeanSerializerBase
protected BeanSerializerBase asArraySerializer()
BeanSerializerBase
asArraySerializer
in class BeanSerializerBase
public void serializeWithType(Object bean, JsonGenerator gen, 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 BeanSerializerBase
bean
- 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.typeSer
- Type serializer to use for including type informationIOException
public final void serialize(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException
BeanPropertyWriter
instances.serialize
in class BeanSerializerBase
bean
- 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
protected final void serializeAsArray(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException
IOException
Copyright © 2008–2021 FasterXML. All rights reserved.