Top Description Fields Constructors Methods
tools.jackson.datatype.hppc.ser

public Class ObjectContainerSerializer

extends ContainerSerializerBase<ObjectContainer<?>>
Class Inheritance
Imports
tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.ser.jdk.ObjectArraySerializer, tools.jackson.databind.ser.std.StdContainerSerializer, tools.jackson.databind.type.*, com.carrotsearch.hppc.*

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

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

Inherited from tools.jackson.datatype.hppc.ser.ContainerSerializerBase:
_schemeElementType

Constructor Summary

AccessConstructor and Description
public
protected

Method Summary

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

Overrides tools.jackson.datatype.hppc.ser.ContainerSerializerBase._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.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).

public ValueSerializer<?>
getContentSerializer()

Overrides tools.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 tools.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 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 ctxt, ObjectContainer<?> value)

Implements abstract tools.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, JsonGenerator gen, SerializationContext ctxt)

Overrides tools.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, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer)

Overrides tools.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
Inherited from tools.jackson.datatype.hppc.ser.ContainerSerializerBase:
getSerializer

Field Detail

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

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

Constructor Detail

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

Method Detail

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

Overrides tools.jackson.datatype.hppc.ser.ContainerSerializerBase._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)

Implements abstract tools.jackson.datatype.hppc.ser.ContainerSerializerBase.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.ValueSerializer.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()

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

Overrides tools.jackson.datatype.hppc.ser.ContainerSerializerBase.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(ObjectContainer<?> 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 ctxt, ObjectContainer<?> value)

Implements abstract tools.jackson.datatype.hppc.ser.ContainerSerializerBase.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 void serialize(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException

Overrides tools.jackson.datatype.hppc.ser.ContainerSerializerBase.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
protected void serializeContents(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.datatype.hppc.ser.ContainerSerializerBase.serializeContents.

Annotations
@Override
serializeWithTypeback to summary
public void serializeWithType(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.datatype.hppc.ser.ContainerSerializerBase.serializeWithType.

Doc from tools.jackson.databind.ValueSerializer.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.
Annotations
@Override
withDelegateback to summary
protected ObjectContainerSerializer withDelegate(ObjectArraySerializer newDelegate)