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).
| Modifier and Type | Field and Description |
|---|---|
| protected final Object | _filterId
Id of the property filter to use, if any; null if none. |
| protected final Set | _ignoredEntries
Set of entries to omit during serialization, if any |
| private final ValueSerializer | |
| 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 | |
| private final TypeSerializer |
| Access | Constructor and Description |
|---|---|
| public | MultimapSerializer(MapLikeType type, BeanDescription.
|
| protected | MultimapSerializer(MultimapSerializer src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys)
|
| Modifier and Type | Method and Description |
|---|---|
| protected Multimap | |
| protected StdContainerSerializer | _withValueTypeSerializer(TypeSerializer typeSer)
Implements abstract tools. Method that needs to be implemented to allow construction of a new
serializer object with given |
| public void | acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
Overrides tools. Implements tools. Default implementation specifies no format. |
| public ValueSerializer | createContextual(SerializationContext ctxt, BeanProperty property)
Overrides tools. 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. 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. Accessor for finding declared (static) element type for type this serializer is used for. |
| public boolean | hasSingleElement(Multimap<?, ?> map)
Implements abstract tools. 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. 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. 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. 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)
|
| _filterId | back to summary |
|---|---|
| protected final Object _filterId Id of the property filter to use, if any; null if none. | |
| _ignoredEntries | back to summary |
|---|---|
| protected final Set<String> _ignoredEntries Set of entries to omit during serialization, if any | |
| _keySerializer | back to summary |
|---|---|
| private final ValueSerializer<Object> _keySerializer | |
| _sortKeys | back to summary |
|---|---|
| protected final boolean _sortKeys Flag set if output is forced to be sorted by keys (usually due to annotation). | |
| _type | back to summary |
|---|---|
| private final MapLikeType _type | |
| _valueSerializer | back to summary |
|---|---|
| private final ValueSerializer<Object> _valueSerializer | |
| _valueTypeSerializer | back to summary |
|---|---|
| private final TypeSerializer _valueTypeSerializer | |
| MultimapSerializer | back to summary |
|---|---|
| public MultimapSerializer(MapLikeType type, BeanDescription. | |
| MultimapSerializer | back to summary |
|---|---|
protected MultimapSerializer(MultimapSerializer src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries, Object filterId, boolean sortKeys)
| |
| _orderEntriesByKey | back to summary |
|---|---|
protected Multimap
| |
| _withValueTypeSerializer | back to summary |
|---|---|
| protected StdContainerSerializer Implements abstract tools. Doc from tools. Method that needs to be implemented to allow construction of a new
serializer object with given
| |
| acceptJsonFormatVisitor | back to summary |
|---|---|
| public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Overrides tools. Implements tools. Doc from tools. Default implementation specifies no format. This behavior is usually overriden by custom serializers.
| |
| createContextual | back to summary |
|---|---|
| public ValueSerializer Overrides tools. Doc from tools. 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.
| |
| getContentSerializer | back to summary |
|---|---|
| public ValueSerializer Implements abstract tools. Doc from tools. 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 | back to summary |
|---|---|
| public JavaType getContentType() Implements abstract tools. Doc from tools. Accessor for finding declared (static) element type for type this serializer is used for.
| |
| hasSingleElement | back to summary |
|---|---|
| public boolean hasSingleElement(Multimap<?, ?> map) Implements abstract tools. Doc from tools. 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
| |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty(SerializationContext ctxt, Multimap<?, ?> value) Implements abstract tools. Doc from tools. 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.
| |
| serialize | back to summary |
|---|---|
| public void serialize(Multimap<?, ?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException Implements abstract tools. Doc from tools. Method that can be called to ask implementation to serialize values of type this serializer handles.
| |
| serializeFields | back to summary |
|---|---|
| private final void serializeFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializationContext ctxt) throws JacksonException | |
| serializeFilteredFields | back to summary |
|---|---|
| private final void serializeFilteredFields(Multimap<?, ?> mmap, JsonGenerator gen, SerializationContext ctxt) throws JacksonException | |
| serializeWithType | back to summary |
|---|---|
| public void serializeWithType(Multimap<?, ?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException Overrides tools. Doc from tools. 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 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.
| |
| withResolved | back to summary |
|---|---|
| protected MultimapSerializer withResolved(BeanProperty property, ValueSerializer<?> keySer, TypeSerializer vts, ValueSerializer<?> valueSer, Set<String> ignored, Object filterId, boolean sortKeys) | |