jackson-databind 2.16.0 · com.fasterxml.jackson.databind.ser.std.ObjectArraySerializer

Modifier and Type	Field and Description
protected PropertySerializerMap	_dynamicSerializers If element type cannot be statically determined, mapping from runtime type to serializer is handled using this object
protected JsonSerializer<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.

Access	Constructor and Description
public	ObjectArraySerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> elementSerializer)
public	ObjectArraySerializer(ObjectArraySerializer src, TypeSerializer vts) Deprecated as a consequence of `ObjectArraySerializer` being deprecated.
public	ObjectArraySerializer(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) Deprecated as a consequence of `ObjectArraySerializer` being deprecated.

Method Summary

Modifier and Type	Method and Description
protected final JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider)
protected final JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
public JsonSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle) Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase._withResolved.
public ContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Deprecated as a consequence of `ContainerSerializer` being deprecated. 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	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType Type of element (entity like property) being visited typeHint) Overrides com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Default implementation specifies no format.
public JsonSerializer<?>	createContextual(SerializerProvider Serializer provider to use for accessing config, other serializers serializers, BeanProperty 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) property) Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.createContextual. Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
public JsonSerializer<?>	getContentSerializer() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.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 com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for.
public boolean	hasSingleElement(Object[] value) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement. Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
public boolean	isEmpty(SerializerProvider prov, Object[] value) Overrides com.fasterxml.jackson.databind.JsonSerializer.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 to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content gen, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider) Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles.
public void	serializeContents(Object[] value, JsonGenerator gen, SerializerProvider provider) Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serializeContents.
public void	serializeContentsUsing(Object[] value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser)
public void	serializeTypedContents(Object[] value, JsonGenerator jgen, SerializerProvider provider)
public ObjectArraySerializer	withResolved(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> ser, Boolean unwrapSingle) Deprecated as a consequence of `ObjectArraySerializer` being deprecated.

Inherited from com.fasterxml.jackson.databind.ser.std.ArraySerializerBase:: _shouldUnwrapSingle serializeWithType

_dynamicSerializers	back to summary
protected PropertySerializerMap _dynamicSerializers If element type cannot be statically determined, mapping from runtime type to serializer is handled using this object

_elementSerializer	back to summary
protected JsonSerializer<Object> _elementSerializer Value serializer to use, if it can be statically determined.

_elementType	back to summary
protected final JavaType _elementType Declared type of element entries

_staticTyping	back to summary
protected final boolean _staticTyping Whether we are using static typing (using declared types, ignoring runtime type) or not for elements.

_valueTypeSerializer	back to summary
protected final TypeSerializer _valueTypeSerializer Type serializer to use for values, if any.

ObjectArraySerializer	back to summary
public ObjectArraySerializer(JavaType elemType, boolean staticTyping, TypeSerializer vts, JsonSerializer<Object> elementSerializer)

ObjectArraySerializer	back to summary
public ObjectArraySerializer(ObjectArraySerializer src, TypeSerializer vts) Deprecated as a consequence of `ObjectArraySerializer` being deprecated. See corresponding docs for further information.

ObjectArraySerializer	back to summary
public ObjectArraySerializer(ObjectArraySerializer src, BeanProperty property, TypeSerializer vts, JsonSerializer<?> elementSerializer, Boolean unwrapSingle) Deprecated as a consequence of `ObjectArraySerializer` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:unchecked

Method Detail

_findAndAddDynamic	back to summary
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException

_findAndAddDynamic	back to summary
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException

_withResolved	back to summary
public JsonSerializer<?> _withResolved(BeanProperty prop, Boolean unwrapSingle) Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase._withResolved. Annotations @Override

_withResolved

back to summary

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

Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase._withResolved.

Annotations

@Override

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer. Deprecated as a consequence of `ContainerSerializer` being deprecated. See corresponding docs for further information. 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

public ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

Deprecated

as a consequence of ContainerSerializer being deprecated. See corresponding docs for further information.

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

acceptJsonFormatVisitor	back to summary
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Overrides com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Doc from com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Default implementation specifies no format. This behavior is usually overriden by custom serializers. Parameters typeHint:JavaType Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Type of element (entity like property) being visited Annotations @Override

acceptJsonFormatVisitor

back to summary

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Doc from com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

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

Parameters

typeHint:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Type of element (entity like property) being visited

Annotations

@Override

createContextual	back to summary
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.createContextual. Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. 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. Parameters serializers:SerializerProvider Serializer provider to use for accessing config, other serializers property:BeanProperty 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:JsonSerializer<?> Serializer to use for serializing values of specified property; may be this instance or a new instance. Annotations @Override

createContextual

back to summary

public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.createContextual.

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

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.

Parameters

serializers:SerializerProvider: Serializer provider to use for accessing config, other serializers
property:BeanProperty: 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:JsonSerializer<?>

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

Annotations

@Override

getContentSerializer back to summary

getContentSerializer	back to summary
public JsonSerializer<?> getContentSerializer() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentSerializer. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 `com.fasterxml.jackson.databind.SerializerProvider#findContentValueSerializer`. Annotations @Override

public JsonSerializer<?> getContentSerializer()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 com.fasterxml.jackson.databind.SerializerProvider#findContentValueSerializer.

Annotations

@Override

getContentType	back to summary
public JavaType getContentType() Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for. Annotations @Override

getContentType

back to summary

public JavaType getContentType()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

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

Annotations

@Override

hasSingleElement back to summary

hasSingleElement	back to summary
public boolean hasSingleElement(Object[] value) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement. Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 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` or `Map.Entry` instances. Annotations @Override

public boolean hasSingleElement(Object[] value)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 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 or Map.Entry instances.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty(SerializerProvider prov, Object[] value) Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty. Doc from com.fasterxml.jackson.databind.JsonSerializer.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. Note replaces `isEmpty(Object)`, which was deprecated in 2.5 Annotations @Override

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

Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty.

Doc from com.fasterxml.jackson.databind.JsonSerializer.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.

Note

replaces isEmpty(Object), which was deprecated in 2.5

Annotations

@Override

serialize	back to summary
public final void serialize(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serialize. Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Parameters value:Object[] Value to serialize; can not be null. gen:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. Annotations @Override

serialize

back to summary

public final void serialize(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException

Overrides com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

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

Parameters

value:Object[]: Value to serialize; can not be null.
gen:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations

@Override

serializeContents	back to summary
public void serializeContents(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serializeContents. Annotations @Override

serializeContents

back to summary

public void serializeContents(Object[] value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.ArraySerializerBase.serializeContents.

Annotations

@Override

serializeContentsUsing	back to summary
public void serializeContentsUsing(Object[] value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser) throws IOException

serializeTypedContents	back to summary
public void serializeTypedContents(Object[] value, JsonGenerator jgen, SerializerProvider provider) throws IOException

withResolved	back to summary
public ObjectArraySerializer withResolved(BeanProperty prop, TypeSerializer vts, JsonSerializer<?> ser, Boolean unwrapSingle) Deprecated as a consequence of `ObjectArraySerializer` being deprecated. See corresponding docs for further information.

public Class ObjectArraySerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail