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

public Class MultimapSerializer

extends StdContainerSerializer<Multimap<?, ?>>
Class Inheritance
Imports
java.util.*, .Map.Entry, com.fasterxml.jackson.annotation.JsonFormat, .JsonIgnoreProperties, tools.jackson.core.*, tools.jackson.core.type.WritableTypeId, tools.jackson.databind.*, tools.jackson.databind.introspect.AnnotatedMember, tools.jackson.databind.jsonFormatVisitors.JsonArrayFormatVisitor, .JsonFormatVisitable, .JsonFormatVisitorWrapper, .JsonMapFormatVisitor, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.ser.PropertyFilter, tools.jackson.databind.ser.jdk.MapProperty, tools.jackson.databind.ser.std.StdContainerSerializer, tools.jackson.databind.type.MapLikeType, com.google.common.collect.Multimap, .TreeMultimap

Serializer for Guava's Multimap values. Output format encloses all value sets in JSON Array, regardless of number of values; this to reduce complexity (and inaccuracy) of trying to handle cases where values themselves would be serialized as arrays (in which cases determining whether given array is a wrapper or value gets complicated and unreliable).

Field Summary

Modifier and TypeField and Description
protected final Object
_filterId

Id of the property filter to use, if any; null if none.

protected final Set<String>
_ignoredEntries

Set of entries to omit during serialization, if any

private final ValueSerializer<Object>
protected final boolean
_sortKeys

Flag set if output is forced to be sorted by keys (usually due to annotation).

private final MapLikeType
private final ValueSerializer<Object>
private final TypeSerializer
Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:
_dynamicValueSerializers_property

Constructor Summary

AccessConstructor and Description
public
MultimapSerializer(MapLikeType type, BeanDescription.Supplier beanDesc, ValueSerializer<Object> keySerializer, TypeSerializer vts, ValueSerializer<Object> valueSerializer, Set<String> ignoredEntries, Object filterId)

protected
MultimapSerializer(MultimapSerializer src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys)

Method Summary

Modifier and TypeMethod and Description
protected Multimap<?, ?>
protected StdContainerSerializer<?>
_withValueTypeSerializer(TypeSerializer typeSer)

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

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(Multimap<?, ?> map)

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, Multimap<?, ?> 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 void
serialize(Multimap<?, ?> value, JsonGenerator gen, 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.

private final void
private final void
public void
serializeWithType(Multimap<?, ?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer)

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

protected MultimapSerializer
withResolved(BeanProperty property, ValueSerializer<?> keySer, TypeSerializer vts, ValueSerializer<?> valueSer, Set<String> ignored, Object filterId, boolean sortKeys)

Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:
_findAndAddDynamic_findAndAddDynamicwithValueTypeSerializer

Field Detail

_filterIdback to summary
protected final Object _filterId

Id of the property filter to use, if any; null if none.

_ignoredEntriesback to summary
protected final Set<String> _ignoredEntries

Set of entries to omit during serialization, if any

_keySerializerback to summary
private final ValueSerializer<Object> _keySerializer
_sortKeysback to summary
protected final boolean _sortKeys

Flag set if output is forced to be sorted by keys (usually due to annotation).

_typeback to summary
private final MapLikeType _type
_valueSerializerback to summary
private final ValueSerializer<Object> _valueSerializer
_valueTypeSerializerback to summary
private final TypeSerializer _valueTypeSerializer

Constructor Detail

MultimapSerializerback to summary
public MultimapSerializer(MapLikeType type, BeanDescription.Supplier beanDesc, ValueSerializer<Object> keySerializer, TypeSerializer vts, ValueSerializer<Object> valueSerializer, Set<String> ignoredEntries, Object filterId)
MultimapSerializerback to summary
protected MultimapSerializer(MultimapSerializer src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys)
Annotations
@SuppressWarnings:unchecked

Method Detail

_orderEntriesByKeyback to summary
protected Multimap<?, ?> _orderEntriesByKey(Multimap<?, ?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException
Annotations
@SuppressWarnings:rawtypes, unchecked
_withValueTypeSerializerback to summary
protected StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer typeSer)

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

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(Multimap<?, ?> map)

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, Multimap<?, ?> 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 void serialize(Multimap<?, ?> value, JsonGenerator gen, 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
serializeFieldsback to summary
private final void serializeFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializationContext ctxt) throws JacksonException
serializeFilteredFieldsback to summary
private final void serializeFilteredFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializationContext ctxt) throws JacksonException
serializeWithTypeback to summary
public void serializeWithType(Multimap<?, ?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.databind.ValueSerializer.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
withResolvedback to summary
protected MultimapSerializer withResolved(BeanProperty property, ValueSerializer<?> keySer, TypeSerializer vts, ValueSerializer<?> valueSer, Set<String> ignored, Object filterId, boolean sortKeys)