Jackson 2.18.2 · com.fasterxml.jackson.datatype.guava.ser.MultimapSerializer

Modifier and Type	Field and Description
protected PropertySerializerMap	_dynamicValueSerializers If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object.
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 JsonSerializer<Object>	_keySerializer
private final BeanProperty	_property
protected final boolean	_sortKeys Flag set if output is forced to be sorted by keys (usually due to annotation).
private final MapLikeType	_type
private final JsonSerializer<Object>	_valueSerializer
private final TypeSerializer	_valueTypeSerializer
private static final long	serialVersionUID Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Access	Constructor and Description
public	MultimapSerializer(MapLikeType type, BeanDescription beanDesc, JsonSerializer<Object> keySerializer, TypeSerializer vts, JsonSerializer<Object> valueSerializer, Set<String> ignoredEntries, Object filterId)
protected	MultimapSerializer(MultimapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, TypeSerializer vts, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys) References Deprecated `MultimapSerializer` is deprecated or references (maybe indirectly) at least one deprecated element.

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)
protected Multimap<?, ?>	_orderEntriesByKey(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider)
protected ContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer typeSer) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._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	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 provider, 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() 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(Multimap<?, ?> map) 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, Multimap<?, ?> 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 void	serialize(Multimap<?, ?> 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) Implements abstract com.fasterxml.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	serializeFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializerProvider provider)
private final void	serializeFilteredFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializerProvider provider)
public void	serializeWithType(Multimap<?, ?> 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.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.
protected MultimapSerializer	withResolved(BeanProperty property, JsonSerializer<?> keySer, TypeSerializer vts, JsonSerializer<?> valueSer, Set<String> ignored, Object filterId, boolean sortKeys) References Deprecated `MultimapSerializer` is deprecated or references (maybe indirectly) at least one deprecated element.

Inherited from com.fasterxml.jackson.databind.ser.ContainerSerializer:: hasContentTypeAnnotation withValueTypeSerializer

_dynamicValueSerializers	back to summary
protected PropertySerializerMap _dynamicValueSerializers If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object. Since 2.5

_filterId	back to summary
protected final Object _filterId Id of the property filter to use, if any; null if none. Since 2.5

_ignoredEntries	back to summary
protected final Set<String> _ignoredEntries Set of entries to omit during serialization, if any Since 2.5

_keySerializer	back to summary
private final JsonSerializer<Object> _keySerializer

_property	back to summary
private final BeanProperty _property

_sortKeys	back to summary
protected final boolean _sortKeys Flag set if output is forced to be sorted by keys (usually due to annotation). Since 2.15

_type	back to summary
private final MapLikeType _type

_valueSerializer	back to summary
private final JsonSerializer<Object> _valueSerializer

_valueTypeSerializer	back to summary
private final TypeSerializer _valueTypeSerializer

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

MultimapSerializer	back to summary
public MultimapSerializer(MapLikeType type, BeanDescription beanDesc, JsonSerializer<Object> keySerializer, TypeSerializer vts, JsonSerializer<Object> valueSerializer, Set<String> ignoredEntries, Object filterId)

MultimapSerializer	back to summary
protected MultimapSerializer(MultimapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, TypeSerializer vts, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys) References Deprecated `MultimapSerializer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Annotations @SuppressWarnings:unchecked Since 2.5

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

_orderEntriesByKey	back to summary
protected Multimap<?, ?> _orderEntriesByKey(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException Since 2.15

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
protected ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer typeSer) Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._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

protected ContainerSerializer<?> _withValueTypeSerializer(TypeSerializer typeSer)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._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

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 provider, 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 provider: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 provider, 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

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

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, Multimap<?, ?> 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, Multimap<?, ?> 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 void serialize(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.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:Multimap<?, ?> 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 void serialize(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.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:Multimap<?, ?>: 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

serializeFields	back to summary
private final void serializeFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializerProvider provider) throws IOException

serializeFilteredFields	back to summary
private final void serializeFilteredFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializerProvider provider) throws IOException

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException Overrides com.fasterxml.jackson.databind.JsonSerializer.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:Multimap<?, ?> 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

public void serializeWithType(Multimap<?, ?> value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException

Overrides com.fasterxml.jackson.databind.JsonSerializer.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:Multimap<?, ?>: 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

withResolved	back to summary
protected MultimapSerializer withResolved(BeanProperty property, JsonSerializer<?> keySer, TypeSerializer vts, JsonSerializer<?> valueSer, Set<String> ignored, Object filterId, boolean sortKeys) References Deprecated `MultimapSerializer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

public Class MultimapSerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail