Class BeanAsArraySerializer
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,ResolvableSerializer
,Serializable
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:
- Unwrapping is used (no way to expand out array in JSON Object)
- Type information ("type id") is to be used: while this could work for some embedding methods, it would likely cause conflicts.
- Object Identity ("object id") is used: while references would work, the problem is inclusion of id itself.
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.
- Since:
- 2.1
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
-
Field Summary
Modifier and TypeFieldDescriptionprotected final BeanSerializerBase
Serializer that would produce JSON Object version; used in cases where array output cannot be used.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.BeanSerializerBase
_anyGetterWriter, _beanType, _filteredProps, _objectIdWriter, _propertyFilterId, _props, _serializationShape, _typeId, NAME_FOR_OBJECT_REF, NO_PROPS
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ModifierConstructorDescriptionprotected
BeanAsArraySerializer
(BeanSerializerBase src, ObjectIdWriter oiw, Object filterId) protected
BeanAsArraySerializer
(BeanSerializerBase src, Set<String> toIgnore) protected
BeanAsArraySerializer
(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude) -
Method Summary
Modifier and TypeMethodDescriptionprotected BeanSerializerBase
Mutant factory for creating a variant that output POJO as a JSON Array.boolean
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.final void
serialize
(Object bean, JsonGenerator gen, SerializerProvider provider) Main serialization method that will delegate actual output to configuredBeanPropertyWriter
instances.protected final 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.toString()
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)withFilterId
(Object filterId) Mutant factory used for creating a new instance with different filter id (used withJsonFilter
annotation)withObjectIdWriter
(ObjectIdWriter objectIdWriter) Mutant factory used for creating a new instance with differentObjectIdWriter
.protected BeanSerializerBase
withProperties
(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Mutant factory used for creating a new instance with modified set of properties.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.BeanSerializerBase
_customTypeId, _serializeObjectId, _serializeWithObjectId, _serializeWithObjectId, _typeIdDef, acceptJsonFormatVisitor, createContextual, findConvertingSerializer, getSchema, properties, resolve, serializeFields, serializeFieldsFiltered, usesObjectId, withIgnorals, withIgnorals
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isEmpty, replaceDelegatee
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsonschema.SchemaAware
getSchema
-
Field Details
-
_defaultSerializer
Serializer that would produce JSON Object version; used in cases where array output cannot be used.
-
-
Constructor Details
-
BeanAsArraySerializer
-
BeanAsArraySerializer
-
BeanAsArraySerializer
protected BeanAsArraySerializer(BeanSerializerBase src, Set<String> toIgnore, Set<String> toInclude) -
BeanAsArraySerializer
-
-
Method Details
-
unwrappingSerializer
Description copied from class:JsonSerializer
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). If no unwrapped serializer can be constructed, will simply return serializer as-is.Default implementation just returns serializer as-is, indicating that no unwrapped variant exists
- Overrides:
unwrappingSerializer
in classJsonSerializer<Object>
- Parameters:
transformer
- Name transformation to use to convert between names of unwrapper properties
-
isUnwrappingSerializer
public boolean isUnwrappingSerializer()Description copied from class:JsonSerializer
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.- Overrides:
isUnwrappingSerializer
in classJsonSerializer<Object>
-
withObjectIdWriter
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with differentObjectIdWriter
.- Specified by:
withObjectIdWriter
in classBeanSerializerBase
-
withFilterId
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with different filter id (used withJsonFilter
annotation)- Specified by:
withFilterId
in classBeanSerializerBase
-
withByNameInclusion
Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)- Specified by:
withByNameInclusion
in classBeanSerializerBase
-
withProperties
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Description copied from class:BeanSerializerBase
Mutant factory used for creating a new instance with modified set of properties.Note: in 2.11.x, need to keep non-abstract for slightly better compatibility (XML module extends)
- Specified by:
withProperties
in classBeanSerializerBase
-
asArraySerializer
Description copied from class:BeanSerializerBase
Mutant factory for creating a variant that output POJO as a JSON Array. Implementations may ignore this request if output as array is not possible (either at all, or reliably).- Specified by:
asArraySerializer
in classBeanSerializerBase
-
serializeWithType
public void serializeWithType(Object bean, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException 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 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, asSTART-ARRAY
/END-ARRAY
andSTART-OBJECT
/END-OBJECT
pairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithType
in classBeanSerializerBase
- Parameters:
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 information- Throws:
IOException
-
serialize
public final void serialize(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException Main serialization method that will delegate actual output to configuredBeanPropertyWriter
instances.- Specified by:
serialize
in classBeanSerializerBase
- Parameters:
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.- Throws:
IOException
-
serializeAsArray
protected final void serializeAsArray(Object bean, JsonGenerator gen, SerializerProvider provider) throws IOException - Throws:
IOException
-
toString
-