Class ObjectArraySerializer
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.ArraySerializerBase<Object[]>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ObjectArraySerializer
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,Serializable
public class ObjectArraySerializer
extends ArraySerializerBase<Object[]>
implements ContextualSerializer
Generic serializer for Object arrays (
Object[]
).- 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 JsonSerializer<Object>
Value serializer to use, if it can be statically determined.protected final JavaType
Declared type of element entriesprotected final boolean
Whether we are using static typing (using declared types, ignoring runtime type) or not for elements.protected final TypeSerializer
Type serializer to use for values, if any.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ArraySerializerBase
_property, _unwrapSingle
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ConstructorDescriptionObjectArraySerializer
(JavaType elemType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> elementSerializer) ObjectArraySerializer
(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) -
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) _withResolved
(BeanProperty prop, Boolean unwrapSingle) Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.void
acceptJsonFormatVisitor
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.createContextual
(SerializerProvider serializers, BeanProperty property) Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.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.boolean
hasSingleElement
(Object[] value) Method called to determine if the given value (of type handled by this serializer) contains exactly one element.boolean
isEmpty
(SerializerProvider prov, Object[] value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).final void
serialize
(Object[] value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.void
serializeContents
(Object[] value, JsonGenerator gen, SerializerProvider provider) void
serializeContentsUsing
(Object[] value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser) void
serializeTypedContents
(Object[] value, JsonGenerator jgen, SerializerProvider provider) withResolved
(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> ser, Boolean unwrapSingle) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.ArraySerializerBase
_shouldUnwrapSingle, serializeWithType
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer
hasContentTypeAnnotation, 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, 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, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
Field Details
-
_staticTyping
protected final boolean _staticTypingWhether we are using static typing (using declared types, ignoring runtime type) or not for elements. -
_elementType
Declared type of element entries -
_valueTypeSerializer
Type serializer to use 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
-
ObjectArraySerializer
public ObjectArraySerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> elementSerializer) -
ObjectArraySerializer
-
ObjectArraySerializer
public ObjectArraySerializer(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle)
-
-
Method Details
-
_withResolved
- Specified by:
_withResolved
in classArraySerializerBase<Object[]>
-
_withValueTypeSerializer
Description copied from class:ContainerSerializer
Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.- Specified by:
_withValueTypeSerializer
in classContainerSerializer<Object[]>
-
withResolved
public ObjectArraySerializer withResolved(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> ser, Boolean unwrapSingle) -
createContextual
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException Description copied from interface:ContextualSerializer
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.- Specified by:
createContextual
in interfaceContextualSerializer
- Overrides:
createContextual
in classArraySerializerBase<Object[]>
- 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<Object[]>
-
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<Object[]>
-
isEmpty
Description copied from class:JsonSerializer
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).Default implementation will consider only null values to be empty.
NOTE: replaces
JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5- Overrides:
isEmpty
in classJsonSerializer<Object[]>
-
hasSingleElement
Description copied from class:ContainerSerializer
Method called to determine if the given value (of type handled by this serializer) contains exactly one element.Note: although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).
Note, too, that as of now (2.9) this method is only called by serializer itself; and specifically is not used for non-array/collection types like
Map
orMap.Entry
instances.- Specified by:
hasSingleElement
in classContainerSerializer<Object[]>
-
serialize
public final void serialize(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException Description copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.- Overrides:
serialize
in classArraySerializerBase<Object[]>
- 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
-
serializeContents
public void serializeContents(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException - Specified by:
serializeContents
in classArraySerializerBase<Object[]>
- Throws:
IOException
-
serializeContentsUsing
public void serializeContentsUsing(Object[] value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser) throws IOException - Throws:
IOException
-
serializeTypedContents
public void serializeTypedContents(Object[] value, JsonGenerator jgen, SerializerProvider provider) throws IOException - Throws:
IOException
-
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<Object[]>
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
-