Top Fields Constructors Methods
com.fasterxml.jackson.datatype.guava.deser.multimap

public abstract Class GuavaMultimapDeserializer<T extends Multimap<Object, Object>>

extends StdDeserializer<T extends Multimap<Object, Object>>
implements ContextualDeserializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.deser.ContextualDeserializer
Known Direct Subclasses
com.fasterxml.jackson.datatype.guava.deser.multimap.list.ArrayListMultimapDeserializer, com.fasterxml.jackson.datatype.guava.deser.multimap.list.LinkedListMultimapDeserializer, com.fasterxml.jackson.datatype.guava.deser.multimap.set.HashMultimapDeserializer, com.fasterxml.jackson.datatype.guava.deser.multimap.set.LinkedHashMultimapDeserializer
Imports
java.io.IOException, java.lang.reflect.InvocationTargetException, .Method, java.util.List, com.fasterxml.jackson.core.JsonParser, .JsonToken, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.deser.ContextualDeserializer, .NullValueProvider, com.fasterxml.jackson.databind.deser.impl.NullsConstantProvider, com.fasterxml.jackson.databind.deser.std.StdDeserializer, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.databind.type.LogicalType, .MapLikeType, com.google.common.collect.ImmutableList, .LinkedListMultimap, .ListMultimap, .Multimap
Author
mvolkhart

Field Summary

Modifier and TypeField and Description
private final Method
creatorMethod

Since we have to use a method to transform from a known multi-map type into actual one, we'll resolve method just once, use it.

private final JsonDeserializer<?>
elementDeserializer

private final TypeDeserializer
elementTypeDeserializer

private final KeyDeserializer
keyDeserializer

private static final List<String>
METHOD_NAMES

private final NullValueProvider
nullProvider

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.StdDeserializer.serialVersionUID.

private final boolean
skipNullValues

private final MapLikeType
type

Inherited from com.fasterxml.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_ACCEPT_ARRAYSF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
public
GuavaMultimapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, JsonDeserializer<?> elementDeserializer)

public
GuavaMultimapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, JsonDeserializer<?> elementDeserializer, Method creatorMethod, NullValueProvider nvp)

Method Summary

Modifier and TypeMethod and Description
protected abstract JsonDeserializer<?>
_createContextual(MapLikeType t, KeyDeserializer kd, TypeDeserializer vtd, JsonDeserializer<?> vd, Method method, NullValueProvider np)

private Throwable
_peel(Throwable t)

public JsonDeserializer<?>
createContextual(DeserializationContext
Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
ctxt, BeanProperty
Method, field or constructor parameter that represents the property (and is used to assign deserialized value). 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' deserializer as is)
property)

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

We need to use this method to properly handle possible contextual variants of key and value deserializers, as well as type deserializers.

protected abstract T
createMultimap()

public T
deserialize(JsonParser
Parser used for reading JSON content
p, DeserializationContext
Context that can be used to access information about this deserialization activity.
ctxt)

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

private T
deserializeContents(JsonParser p, DeserializationContext ctxt)

private T
deserializeFromSingleValue(JsonParser p, DeserializationContext ctxt)

private void
expect(JsonParser p, JsonToken token)

private static Method
findTransformer(Class<?> rawType)

private Object
getCurrentTokenValue(JsonParser p, DeserializationContext ctxt)

public LogicalType
logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from com.fasterxml.jackson.databind.deser.std.StdDeserializer:
_byteOverflow_checkBooleanToStringCoercion_checkCoercionFail_checkDoubleSpecialValue_checkFloatSpecialValue_checkFloatToIntCoercion_checkFloatToStringCoercion_checkFromStringCoercion_checkFromStringCoercion_checkIntToFloatCoercion_checkIntToStringCoercion_checkTextualNull_checkToStringCoercion_coerceBooleanFromInt_coercedTypeDesc_coercedTypeDesc_coerceEmptyString_coerceIntegral_coerceNullToken_coerceTextualNull_deserializeFromArray_deserializeFromEmpty_deserializeFromEmptyString_deserializeFromString_deserializeWrappedValue_failDoubleToIntCoercion_findCoercionFromBlankString_findCoercionFromEmptyArray_findCoercionFromEmptyString_findNullProvider_hasTextualNull_intOverflow_isBlank_isEmptyOrTextualNull_isFalse_isIntNumber_isNaN_isNegInf_isPosInf_isTrue_neitherNull_nonNullNumber_parseBoolean_parseBooleanFromInt_parseBooleanPrimitive_parseBooleanPrimitive_parseBytePrimitive_parseDate_parseDate_parseDateFromArray_parseDouble_parseDouble_parseDoublePrimitive_parseDoublePrimitive_parseDoublePrimitive_parseFloatPrimitive_parseFloatPrimitive_parseFloatPrimitive_parseInteger_parseInteger_parseIntPrimitive_parseIntPrimitive_parseLong_parseLong_parseLongPrimitive_parseLongPrimitive_parseShortPrimitive_parseString_parseString_reportFailedNullCoerce_shortOverflow_verifyEndArrayForSingle_verifyNullForPrimitive_verifyNullForPrimitiveCoercion_verifyNullForScalarCoercion_verifyNumberForScalarCoercion_verifyStringForScalarCoerciondeserializeWithTypefindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueClassgetValueInstantiatorgetValueTypegetValueTypehandledTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Field Detail

creatorMethodback to summary
private final Method creatorMethod

Since we have to use a method to transform from a known multi-map type into actual one, we'll resolve method just once, use it. Note that if this is set to null, we can just construct a com.google.common.collect.LinkedListMultimap instance and be done with it.

elementDeserializerback to summary
private final JsonDeserializer<?> elementDeserializer
elementTypeDeserializerback to summary
private final TypeDeserializer elementTypeDeserializer
keyDeserializerback to summary
private final KeyDeserializer keyDeserializer
METHOD_NAMESback to summary
private static final List<String> METHOD_NAMES
nullProviderback to summary
private final NullValueProvider nullProvider
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.StdDeserializer.serialVersionUID.

skipNullValuesback to summary
private final boolean skipNullValues
typeback to summary
private final MapLikeType type

Constructor Detail

GuavaMultimapDeserializerback to summary
public GuavaMultimapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, JsonDeserializer<?> elementDeserializer)
GuavaMultimapDeserializerback to summary
public GuavaMultimapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, JsonDeserializer<?> elementDeserializer, Method creatorMethod, NullValueProvider nvp)

Method Detail

_createContextualback to summary
protected abstract JsonDeserializer<?> _createContextual(MapLikeType t, KeyDeserializer kd, TypeDeserializer vtd, JsonDeserializer<?> vd, Method method, NullValueProvider np)
_peelback to summary
private Throwable _peel(Throwable t)
createContextualback to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

We need to use this method to properly handle possible contextual variants of key and value deserializers, as well as type deserializers.

Parameters
ctxt:DeserializationContext

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property:BeanProperty

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method, field or constructor parameter that represents the property (and is used to assign deserialized value). 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' deserializer as is)

Returns:JsonDeserializer<?>

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations
@Override
createMultimapback to summary
protected abstract T createMultimap()
deserializeback to summary
public T deserialize(JsonParser p, DeserializationContext ctxt) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never JSON 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker or a FIELD_NAME.

The two possible input conditions for structured types result from polymorphism via fields. In the ordinary case, Jackson calls this method when it has encountered an OBJECT_START, and the method implementation must advance to the next token to see the first field name. If the application configures polymorphism via a field, then the object looks like the following. 

      {
          "@class": "class name",
          ...
      }
Jackson consumes the two tokens (the @class field name and its value) in order to learn the class and select the deserializer. Thus, the stream is pointing to the FIELD_NAME for the first field after the @class. Thus, if you want your method to work correctly both with and without polymorphism, you must begin your method with: 
       if (p.currentToken() == JsonToken.START_OBJECT) {
         p.nextToken();
       }
This results in the stream pointing to the field name, so that the two conditions align.

Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the JsonDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer#getNullValue(DeserializationContext) and usually also JsonDeserializer#getNullAccessPattern().

Parameters
p:JsonParser

Parser used for reading JSON content

ctxt:DeserializationContext

Context that can be used to access information about this deserialization activity.

Returns:T

Deserialized value

Annotations
@Override
deserializeContentsback to summary
private T deserializeContents(JsonParser p, DeserializationContext ctxt) throws IOException
deserializeFromSingleValueback to summary
private T deserializeFromSingleValue(JsonParser p, DeserializationContext ctxt) throws IOException
expectback to summary
private void expect(JsonParser p, JsonToken token) throws IOException
findTransformerback to summary
private static Method findTransformer(Class<?> rawType)
getCurrentTokenValueback to summary
private Object getCurrentTokenValue(JsonParser p, DeserializationContext ctxt) throws IOException
logicalTypeback to summary
public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.

Returns:LogicalType

Logical type of values this deserializer produces, if known; null if not

Annotations
@Override