Top Description Fields Constructors Methods
com.fasterxml.jackson.datatype.hppc.ser

public Class ObjectContainerSerializer

extends ContainerSerializerBase<ObjectContainer<?>>
implements ContextualSerializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.ser.ContextualSerializer
Imports
java.io.IOException, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper, com.fasterxml.jackson.databind.jsontype.TypeSerializer, com.fasterxml.jackson.databind.ser.ContainerSerializer, .ContextualSerializer, com.fasterxml.jackson.databind.ser.std.ObjectArraySerializer, com.fasterxml.jackson.databind.type.*, com.carrotsearch.hppc.*

References Deprecated

ContainerSerializerBase is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Note

this implementation does not yet properly handle all polymorphic cases

Field Summary

Modifier and TypeField and Description
protected final JavaType
protected final ObjectArraySerializer
_delegate

References Deprecated ObjectArraySerializer is deprecated or references (maybe indirectly) at least one deprecated element.
We will basically just delegate serialization to the standard Object[] serializer; as we can not sub-class it.
private static final long
Inherited from com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase:
_schemeElementType

Constructor Summary

AccessConstructor and Description
public
ObjectContainerSerializer(CollectionLikeType containerType, ObjectArraySerializer delegate)
References Deprecated ObjectArraySerializer is deprecated or references (maybe indirectly) at least one deprecated element.

protected
ObjectContainerSerializer(ObjectContainerSerializer base, ObjectArraySerializer delegate)
References Deprecated ObjectContainerSerializer and ObjectArraySerializer are deprecated or reference (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and TypeMethod and Description
protected ContainerSerializer<?>
_withValueTypeSerializer(TypeSerializer vts)

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase._withValueTypeSerializer.

References Deprecated ContainerSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

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 JsonSerializer<?>
createContextual(SerializerProvider
Serializer provider to use for accessing config, other serializers
prov
,
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
)

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

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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()

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.getContentType.

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

public boolean
hasSingleElement(ObjectContainer<?> 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 provider, ObjectContainer<?> value)

Implements abstract com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.isEmpty.

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

public void
serialize(ObjectContainer<?>
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.datatype.hppc.ser.ContainerSerializerBase.serialize.

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

protected void
public void
serializeWithType(ObjectContainer<?>
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
,
TypeSerializer
Type serializer to use for including type information
typeSer
)

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.serializeWithType.

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.

protected ObjectContainerSerializer
withDelegate(ObjectArraySerializer newDelegate)
References Deprecated ObjectArraySerializer and ObjectContainerSerializer are deprecated or reference (maybe indirectly) at least one deprecated element.

Inherited from com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase:
getSchemagetSerializer

Field Detail

_contentTypeback to summary
protected final JavaType _contentType
_delegateback to summary
protected final ObjectArraySerializer _delegate

References Deprecated

ObjectArraySerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

We will basically just delegate serialization to the standard Object[] serializer; as we can not sub-class it.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.serialVersionUID.

Constructor Detail

ObjectContainerSerializerback to summary
public ObjectContainerSerializer(CollectionLikeType containerType, ObjectArraySerializer delegate)

References Deprecated

ObjectArraySerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

ObjectContainerSerializerback to summary
protected ObjectContainerSerializer(ObjectContainerSerializer base, ObjectArraySerializer delegate)

References Deprecated

ObjectContainerSerializer and ObjectArraySerializer are deprecated or reference (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method Detail

_withValueTypeSerializerback to summary
protected ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase._withValueTypeSerializer.

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

References Deprecated

ContainerSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

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
acceptJsonFormatVisitorback to summary
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException

Implements abstract com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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
createContextualback to summary
public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException

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
prov: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
getContentSerializerback to summary
public JsonSerializer<?> getContentSerializer()

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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
getContentTypeback to summary
public JavaType getContentType()

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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
hasSingleElementback to summary
public boolean hasSingleElement(ObjectContainer<?> 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
isEmptyback to summary
public boolean isEmpty(SerializerProvider provider, ObjectContainer<?> value)

Implements abstract com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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
serializeback to summary
public void serialize(ObjectContainer<?> value, JsonGenerator gen, SerializerProvider provider) throws IOException

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.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:ObjectContainer<?>

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
serializeContentsback to summary
protected void serializeContents(ObjectContainer<?> value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.serializeContents.

Annotations
@Override
serializeWithTypeback to summary
public void serializeWithType(ObjectContainer<?> value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException

Overrides com.fasterxml.jackson.datatype.hppc.ser.ContainerSerializerBase.serializeWithType.

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

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, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.
Parameters
value:ObjectContainer<?>

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.

typeSer:TypeSerializer

Type serializer to use for including type information

Annotations
@Override
withDelegateback to summary
protected ObjectContainerSerializer withDelegate(ObjectArraySerializer newDelegate)

References Deprecated

ObjectArraySerializer and ObjectContainerSerializer are deprecated or reference (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.