Module tools.jackson.databind

Package tools.jackson.databind.ser.jdk

Class ObjectArraySerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<T>

tools.jackson.databind.ser.std.StdSerializer<T>

tools.jackson.databind.ser.std.StdContainerSerializer<T>

tools.jackson.databind.ser.std.ArraySerializerBase<Object[]>

tools.jackson.databind.ser.jdk.ObjectArraySerializer

All Implemented Interfaces:

JsonFormatVisitable

public class ObjectArraySerializer
extends ArraySerializerBase<Object[]>

Generic serializer for Object arrays (Object[]).

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueSerializer

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected ValueSerializer<Object>	_elementSerializer	Value serializer to use, if it can be statically determined.
protected final JavaType	_elementType	Declared type of element entries
protected final boolean	_staticTyping	Whether we are using static typing (using declared types, ignoring runtime type) or not for elements.
protected final TypeSerializer	_valueTypeSerializer	Type serializer to use for values, if any.

Fields inherited from class tools.jackson.databind.ser.std.ArraySerializerBase

_unwrapSingle

Fields inherited from class tools.jackson.databind.ser.std.StdContainerSerializer

_dynamicValueSerializers, _property

Fields inherited from class tools.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Constructor	Description
ObjectArraySerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, ValueSerializer<Object> elementSerializer)
ObjectArraySerializer(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle)
ObjectArraySerializer(ObjectArraySerializer src, TypeSerializer vts)

Method Summary

Modifier and Type	Method	Description
ValueSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle)
StdContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts)	Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
ValueSerializer<?>	createContextual(SerializationContext ctxt, BeanProperty property)	Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed).
ValueSerializer<?>	getContentSerializer()	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.
JavaType	getContentType()	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(SerializationContext 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 g, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeContents(Object[] value, JsonGenerator g, SerializationContext ctxt)
void	serializeContentsUsing(Object[] value, JsonGenerator g, SerializationContext provider, ValueSerializer<Object> ser)
void	serializeTypedContents(Object[] value, JsonGenerator g, SerializationContext ctxt)
ObjectArraySerializer	withResolved(BeanProperty prop, TypeSerializer vts, ValueSerializer<?> ser, Boolean unwrapSingle)

Methods inherited from class tools.jackson.databind.ser.std.ArraySerializerBase

_shouldUnwrapSingle, serializeWithType

Methods inherited from class tools.jackson.databind.ser.std.StdContainerSerializer

_findAndAddDynamic, _findAndAddDynamic, withValueTypeSerializer

Methods inherited from class tools.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, _wrapIOFailure, acceptJsonFormatVisitorForBinary, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class tools.jackson.databind.ValueSerializer

getDelegatee, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, withIgnoredProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_staticTyping

protected final boolean _staticTyping

Whether we are using static typing (using declared types, ignoring runtime type) or not for elements.

_elementType

protected final JavaType _elementType

Declared type of element entries

_valueTypeSerializer

protected final TypeSerializer _valueTypeSerializer

Type serializer to use for values, if any.

_elementSerializer

protected ValueSerializer<Object> _elementSerializer

Value serializer to use, if it can be statically determined.

Constructor Details

ObjectArraySerializer

public ObjectArraySerializer(JavaType elemType,
 boolean staticTyping,
 TypeSerializer vts,
 ValueSerializer<Object> elementSerializer)

ObjectArraySerializer

public ObjectArraySerializer(ObjectArraySerializer src,
 TypeSerializer vts)

ObjectArraySerializer

public ObjectArraySerializer(ObjectArraySerializer src,
 BeanProperty property,
 TypeSerializer vts,
 ValueSerializer<?> elementSerializer,
 Boolean unwrapSingle)

Method Details

_withResolved

public ValueSerializer<?> _withResolved(BeanProperty prop,
 Boolean unwrapSingle)

Specified by:

_withResolved in class ArraySerializerBase<Object[]>

_withValueTypeSerializer

public StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Description copied from class: StdContainerSerializer

Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.

Specified by:

_withValueTypeSerializer in class StdContainerSerializer<Object[]>

withResolved

public ObjectArraySerializer withResolved(BeanProperty prop,
 TypeSerializer vts,
 ValueSerializer<?> ser,
 Boolean unwrapSingle)

createContextual

public ValueSerializer<?> createContextual(SerializationContext ctxt,
 BeanProperty property)

Description copied from class: ValueSerializer

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). 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.

Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

Overrides:

createContextual in class ArraySerializerBase<Object[]>

Parameters:

ctxt - Context to use for accessing config, other serializers

property - Property (defined by one or more accessors - field or method - used for accessing logical property value) for which serializer is used to be used; or, `null` for root value (or in cases where caller does not have this information, which is handled as root value case).

Returns:

Serializer to use for serializing values of specified property; may be this instance or a new instance.

getContentType

public JavaType getContentType()

Description copied from class: StdContainerSerializer

Accessor for finding declared (static) element type for type this serializer is used for.

Specified by:

getContentType in class StdContainerSerializer<Object[]>

getContentSerializer

public ValueSerializer<?> getContentSerializer()

Description copied from class: StdContainerSerializer

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 use StdContainerSerializer.getContentType() and SerializationContext.findContentValueSerializer(tools.jackson.databind.JavaType, tools.jackson.databind.BeanProperty).

Specified by:

getContentSerializer in class StdContainerSerializer<Object[]>

isEmpty

public boolean isEmpty(SerializationContext prov,
 Object[] value)

Description copied from class: ValueSerializer

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.

Specified by:

isEmpty in class StdContainerSerializer<Object[]>

hasSingleElement

public boolean hasSingleElement(Object[] value)

Description copied from class: StdContainerSerializer

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 this method is only called by serializer itself; and specifically is not used for non-array/collection types like Map or Map.Entry instances.

Specified by:

hasSingleElement in class StdContainerSerializer<Object[]>

serialize

public final void serialize(Object[] value,
 JsonGenerator g,
 SerializationContext ctxt)
                     throws JacksonException

Description copied from class: ValueSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles.

Specified by:

serialize in class StdSerializer<Object[]>

Parameters:

value - Value to serialize; can not be null.

g - Generator used to output resulting Json content

ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.

Throws:

JacksonException

serializeContents

public void serializeContents(Object[] value,
 JsonGenerator g,
 SerializationContext ctxt)
                       throws JacksonException

Specified by:

serializeContents in class ArraySerializerBase<Object[]>

Throws:

JacksonException

serializeContentsUsing

public void serializeContentsUsing(Object[] value,
 JsonGenerator g,
 SerializationContext provider,
 ValueSerializer<Object> ser)
                            throws JacksonException

Throws:

JacksonException

serializeTypedContents

public void serializeTypedContents(Object[] value,
 JsonGenerator g,
 SerializationContext ctxt)
                            throws JacksonException

Throws:

JacksonException

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)

Description copied from class: StdSerializer

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Specified by:

acceptJsonFormatVisitor in interface JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class StdSerializer<Object[]>

typeHint - Type of element (entity like property) being visited