Top Description Fields Constructors Methods
tools.jackson.databind.ser.jdk

public Class ObjectArraySerializer

extends ArraySerializerBase<Object[]>
Class Inheritance
Annotations
@JacksonStdImpl
Imports
java.util.Objects, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.annotation.JacksonStdImpl, tools.jackson.databind.introspect.AnnotatedMember, tools.jackson.databind.jsonFormatVisitors.JsonArrayFormatVisitor, .JsonFormatVisitorWrapper, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.ser.std.ArraySerializerBase, .StdContainerSerializer

Generic serializer for Object arrays (Object[]).

Field Summary

Modifier and TypeField and 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.

Inherited from tools.jackson.databind.ser.std.ArraySerializerBase:
_unwrapSingle

Constructor Summary

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

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

Method Summary

Modifier and TypeMethod and Description
public ValueSerializer<?>
public StdContainerSerializer<?>
_withValueTypeSerializer(TypeSerializer vts)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

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.

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

Overrides tools.jackson.databind.ser.std.ArraySerializerBase.createContextual.

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).

public ValueSerializer<?>
getContentSerializer()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.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.

public JavaType
getContentType()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

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

public boolean
hasSingleElement(Object[] value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

Method called to determine if the given value (of type handled by this serializer) contains exactly one element.

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

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty.

Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

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

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

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

public void
public void
public void
public ObjectArraySerializer
Inherited from tools.jackson.databind.ser.std.ArraySerializerBase:
_shouldUnwrapSingleserializeWithType

Field Detail

_elementSerializerback to summary
protected ValueSerializer<Object> _elementSerializer

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

_elementTypeback to summary
protected final JavaType _elementType

Declared type of element entries

_staticTypingback to summary
protected final boolean _staticTyping

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

_valueTypeSerializerback to summary
protected final TypeSerializer _valueTypeSerializer

Type serializer to use for values, if any.

Constructor Detail

ObjectArraySerializerback to summary
public ObjectArraySerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, ValueSerializer<Object> elementSerializer)
ObjectArraySerializerback to summary
public ObjectArraySerializer(ObjectArraySerializer src, TypeSerializer vts)
ObjectArraySerializerback to summary
public ObjectArraySerializer(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, ValueSerializer<?> elementSerializer, Boolean unwrapSingle)
Annotations
@SuppressWarnings:unchecked

Method Detail

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

Implements abstract tools.jackson.databind.ser.std.ArraySerializerBase._withResolved.

Annotations
@Override
_withValueTypeSerializerback to summary
public StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer.

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.

Annotations
@Override
acceptJsonFormatVisitorback to summary
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)

Overrides tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Implements tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Doc from tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

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

Annotations
@Override
createContextualback to summary
public ValueSerializer<?> createContextual(SerializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ser.std.ArraySerializerBase.createContextual.

Doc from tools.jackson.databind.ValueSerializer.createContextual.

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.

Annotations
@Override
getContentSerializerback to summary
public ValueSerializer<?> getContentSerializer()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.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. Note that for dynamic types this may return null; if so, caller has to instead use getContentType() and tools.jackson.databind.SerializationContext#findContentValueSerializer.

Annotations
@Override
getContentTypeback to summary
public JavaType getContentType()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

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

Annotations
@Override
hasSingleElementback to summary
public boolean hasSingleElement(Object[] value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement.

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.

Annotations
@Override
isEmptyback to summary
public boolean isEmpty(SerializationContext prov, Object[] value)

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty.

Doc from tools.jackson.databind.ValueSerializer.isEmpty.

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.

Annotations
@Override
serializeback to summary
public final void serialize(Object[] value, JsonGenerator g, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

Doc from tools.jackson.databind.ValueSerializer.serialize.

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

Annotations
@Override
serializeContentsback to summary
public void serializeContents(Object[] value, JsonGenerator g, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.ArraySerializerBase.serializeContents.

Annotations
@Override
serializeContentsUsingback to summary
public void serializeContentsUsing(Object[] value, JsonGenerator g, SerializationContext provider, ValueSerializer<Object> ser) throws JacksonException
serializeTypedContentsback to summary
public void serializeTypedContents(Object[] value, JsonGenerator g, SerializationContext ctxt) throws JacksonException
withResolvedback to summary
public ObjectArraySerializer withResolved(BeanProperty prop, TypeSerializer vts, ValueSerializer<?> ser, Boolean unwrapSingle)