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 can not be used.
|
_anyGetterWriter, _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,
String[] toIgnore) |
| 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 jgen,
SerializerProvider provider)
Main serialization method that will delegate actual output to
configured
BeanPropertyWriter instances. |
protected void |
serializeAsArray(Object bean,
JsonGenerator jgen,
SerializerProvider provider) |
void |
serializeWithType(Object bean,
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.
|
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 BeanSerializerBase |
withFilterId(Object filterId)
Mutant factory used for creating a new instance with different
filter id (used with
JsonFilter annotation) |
protected BeanAsArraySerializer |
withIgnorals(String[] toIgnore)
Mutant factory used for creating a new instance with additional
set of properties to ignore (from properties this instance otherwise has)
|
BeanSerializerBase |
withObjectIdWriter(ObjectIdWriter objectIdWriter)
Mutant factory used for creating a new instance with different
ObjectIdWriter. |
_serializeObjectId, _serializeWithObjectId, _serializeWithObjectId, acceptJsonFormatVisitor, createContextual, findConvertingSerializer, getSchema, resolve, serializeFields, serializeFieldsFiltered, usesObjectIdcreateObjectNode, createSchemaNode, createSchemaNode, findConvertingContentSerializer, findPropertyFilter, getSchema, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrowgetDelegatee, isEmpty, replaceDelegateeclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetSchemaprotected final BeanSerializerBase _defaultSerializer
public BeanAsArraySerializer(BeanSerializerBase src)
protected BeanAsArraySerializer(BeanSerializerBase src, String[] toIgnore)
protected BeanAsArraySerializer(BeanSerializerBase src, ObjectIdWriter oiw, Object filterId)
public JsonSerializer<Object> unwrappingSerializer(NameTransformer transformer)
JsonSerializerDefault 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()
JsonSerializerisUnwrappingSerializer in class JsonSerializer<Object>public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)
BeanSerializerBaseObjectIdWriter.withObjectIdWriter in class BeanSerializerBaseprotected BeanSerializerBase withFilterId(Object filterId)
BeanSerializerBaseJsonFilter annotation)withFilterId in class BeanSerializerBaseprotected BeanAsArraySerializer withIgnorals(String[] toIgnore)
BeanSerializerBasewithIgnorals in class BeanSerializerBaseprotected BeanSerializerBase asArraySerializer()
BeanSerializerBaseasArraySerializer in class BeanSerializerBasepublic void serializeWithType(Object bean, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonGenerationException
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, jgen); serialize(value, jgen, provider); typeSer.writeTypeSuffixForScalar(value, jgen);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 BeanSerializerBasebean - 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 informationIOExceptionJsonGenerationExceptionpublic final void serialize(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
BeanPropertyWriter instances.serialize in class BeanSerializerBasebean - 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.IOExceptionJsonGenerationExceptionprotected final void serializeAsArray(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException
IOExceptionJsonGenerationExceptionCopyright © 2014-2015 FasterXML. All Rights Reserved.