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

public Class RangeMapDeserializer<T extends RangeMap<Comparable<?>, Object>>

extends StdDeserializer<T extends RangeMap<Comparable<?>, Object>>
Class Inheritance
Imports
java.lang.reflect.InvocationTargetException, .Method, java.util.List, com.google.common.collect.*, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, tools.jackson.databind.*, tools.jackson.databind.deser.NullValueProvider, tools.jackson.databind.deser.impl.NullsConstantProvider, tools.jackson.databind.deser.std.StdDeserializer, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType, .MapLikeType, tools.jackson.databind.util.ClassUtil

Jackson deserializer for a Guava RangeMap.

Only string serializable ranges are supported at this time.

Author
mcvayc

Field Summary

Modifier and TypeField and Description
private final Method
creatorMethod

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

private final ValueDeserializer<?>
private final TypeDeserializer
private final boolean
private final KeyDeserializer
private static final List<String>
private final NullValueProvider
private final boolean
private final MapLikeType
Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
public
RangeMapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, boolean isImmutable)

public
RangeMapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, Method creatorMethod, NullValueProvider nvp, boolean isImmutable)

Method Summary

Modifier and TypeMethod and Description
public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

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

public T
deserialize(JsonParser p, DeserializationContext ctxt)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

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

private void
expect(DeserializationContext context, JsonToken expected, JsonToken actual)

private static Method
findTransformer(Class<?> rawType)

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_byteOverflow_checkBooleanToStringCoercion_checkCoercionFail_checkDoubleSpecialValue_checkFloatSpecialValue_checkFloatToIntCoercion_checkFloatToStringCoercion_checkFromStringCoercion_checkFromStringCoercion_checkIntToFloatCoercion_checkIntToStringCoercion_checkTextualNull_checkToStringCoercion_coerceBooleanFromInt_coercedTypeDesc_coercedTypeDesc_coerceIntegral_deserializeFromArray_deserializeFromEmptyString_deserializeFromString_deserializeWrappedValue_findCoercionFromBlankString_findCoercionFromEmptyArray_findCoercionFromEmptyString_findNullProvider_hasTextualNull_intOverflow_isBlank_isFalse_isIntNumber_isNaN_isNegInf_isPosInf_isTrue_neitherNull_nonNullNumber_parseBoolean_parseBooleanPrimitive_parseBytePrimitive_parseDate_parseDate_parseDateFromArray_parseDouble_parseDoublePrimitive_parseDoublePrimitive_parseFloatPrimitive_parseFloatPrimitive_parseInteger_parseInteger_parseIntPrimitive_parseIntPrimitive_parseLong_parseLong_parseLongPrimitive_parseLongPrimitive_parseShortPrimitive_parseString_reportFailedNullCoerce_shortOverflow_verifyEndArrayForSingle_verifyNullForPrimitive_verifyNullForPrimitiveCoercion_wrapIOFailuredeserializeWithTypefindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueInstantiatorgetValueTypegetValueTypehandledTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Field Detail

creatorMethodback to summary
private final Method creatorMethod

Since we have to use a method to transform from a known range-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 TreeRangeMap instance and be done with it.

elementDeserializerback to summary
private final ValueDeserializer<?> elementDeserializer
elementTypeDeserializerback to summary
private final TypeDeserializer elementTypeDeserializer
isImmutableback to summary
private final boolean isImmutable
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
skipNullValuesback to summary
private final boolean skipNullValues
typeback to summary
private final MapLikeType type

Constructor Detail

RangeMapDeserializerback to summary
public RangeMapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, boolean isImmutable)
RangeMapDeserializerback to summary
public RangeMapDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, Method creatorMethod, NullValueProvider nvp, boolean isImmutable)

Method Detail

createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

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

Annotations
@Override
deserializeback to summary
public T deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.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 ValueDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer#getNullValue(DeserializationContext) and usually also ValueDeserializer#getNullAccessPattern().

Annotations
@SuppressWarnings:unchecked
@Override
expectback to summary
private void expect(DeserializationContext context, JsonToken expected, JsonToken actual)
findTransformerback to summary
private static Method findTransformer(Class<?> rawType)
logicalTypeback to summary
public LogicalType logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Doc from tools.jackson.databind.ValueDeserializer.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.

Annotations
@Override