Class AsArraySerializerBase<T>
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.AsArraySerializerBase<T>
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,Serializable
- Direct Known Subclasses:
CollectionSerializer
,EnumSetSerializer
,IndexedListSerializer
,IterableSerializer
,IteratorSerializer
public abstract class AsArraySerializerBase<T>
extends ContainerSerializer<T>
implements ContextualSerializer
Base class for serializers that will output contents as JSON
arrays; typically serializers used for
Collection
and array types.- 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 PropertySerializerMap
If element type cannot be statically determined, mapping from runtime type to serializer is handled using this objectprotected final 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 Boolean
Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.protected final TypeSerializer
Type serializer used for values, if any.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ModifierConstructorDescriptionprotected
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 elementType, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) General purpose constructor.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 BeanPropertyprotected
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. -
Method Summary
Modifier and TypeMethodDescriptionprotected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, JavaType type, SerializerProvider provider) protected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, Class<?> type, SerializerProvider provider) void
acceptJsonFormatVisitor
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.createContextual
(SerializerProvider serializers, BeanProperty property) This method is needed to resolve contextual annotations like per-property overrides, as well as do recursive call tocreateContextual
of content serializer, if known statically.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.Accessor for finding declared (static) element type for type this serializer is used for.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.final 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) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer
_withValueTypeSerializer, hasContentTypeAnnotation, hasSingleElement, withValueTypeSerializer
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, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
Field Details
-
_elementType
-
_property
Collection-valued property being serialized with this instance -
_staticTyping
protected final boolean _staticTyping -
_unwrapSingle
Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.- Since:
- 2.6
-
_valueTypeSerializer
Type serializer used for values, if any. -
_elementSerializer
Value serializer to use, if it can be statically determined -
_dynamicSerializers
If element type cannot be statically determined, mapping from runtime type to serializer is handled using this object
-
-
Constructor Details
-
AsArraySerializerBase
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.- Since:
- 2.6
-
AsArraySerializerBase
@Deprecated 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 -
AsArraySerializerBase
protected AsArraySerializerBase(Class<?> cls, JavaType elementType, boolean staticTyping, TypeSerializer vts, BeanProperty property, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) General purpose constructor. Use contextual constructors, if possible.- Since:
- 2.12
-
AsArraySerializerBase
protected AsArraySerializerBase(AsArraySerializerBase<?> src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) -
AsArraySerializerBase
@Deprecated protected AsArraySerializerBase(AsArraySerializerBase<?> src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer) Deprecated.since 2.6: use the overloaded method that takes 'unwrapSingle'
-
-
Method Details
-
withResolved
@Deprecated public final AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer) Deprecated.since 2.6: use the overloaded method that takes 'unwrapSingle' -
withResolved
public abstract AsArraySerializerBase<T> withResolved(BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) - Since:
- 2.6
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException This method is needed to resolve contextual annotations like per-property overrides, as well as do recursive call tocreateContextual
of content serializer, if known statically.- Specified by:
createContextual
in interfaceContextualSerializer
- Parameters:
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)- Returns:
- Serializer to use for serializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
getContentType
Description copied from class:ContainerSerializer
Accessor for finding declared (static) element type for type this serializer is used for.- Specified by:
getContentType
in classContainerSerializer<T>
-
getContentSerializer
Description copied from class:ContainerSerializer
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. Note that for dynamic types this may return null; if so, caller has to instead useContainerSerializer.getContentType()
andSerializerProvider.findContentValueSerializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty)
.- Specified by:
getContentSerializer
in classContainerSerializer<T>
-
serialize
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 classStdSerializer<T>
- Parameters:
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.- Throws:
IOException
-
serializeWithType
public void serializeWithType(T value, JsonGenerator g, 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 classJsonSerializer<T>
- Parameters:
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 information- Throws:
IOException
-
serializeContents
protected abstract void serializeContents(T value, JsonGenerator gen, SerializerProvider provider) throws IOException - Throws:
IOException
-
getSchema
Description copied from class:StdSerializer
Default implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classStdSerializer<T>
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-
acceptJsonFormatVisitor
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Description copied from class:StdSerializer
Default implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitor
in interfaceJsonFormatVisitable
- Overrides:
acceptJsonFormatVisitor
in classStdSerializer<T>
typeHint
- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
_findAndAddDynamic
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException - Throws:
JsonMappingException
-
_findAndAddDynamic
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException - Throws:
JsonMappingException
-