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

public abstract Class GuavaCacheDeserializer<T extends Cache<Object, Object>>

extends StdDeserializer<T extends Cache<Object, Object>>
Class Inheritance
Known Direct Subclasses
tools.jackson.datatype.guava.deser.SimpleCacheDeserializer
Imports
com.google.common.cache.Cache, tools.jackson.core.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

Field Summary

Modifier and TypeField and Description
private final ValueDeserializer<?>
elementDeserializer

private final TypeDeserializer
elementTypeDeserializer

private final KeyDeserializer
keyDeserializer

private final NullValueProvider
nullProvider

private final boolean
skipNullValues

private final MapLikeType
type

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

Constructor Summary

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

public
GuavaCacheDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, NullValueProvider nvp)

Method Summary

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

protected void
_tryToAddNull(JsonParser p, DeserializationContext ctxt, T cache, Object key)

Some/many Guava containers do not allow addition of null values, so isolate handling here.

protected abstract T
createCache()

public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

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 T
deserializeContents(JsonParser p, DeserializationContext ctxt)

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

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

elementDeserializerback to summary
private final ValueDeserializer<?> elementDeserializer
elementTypeDeserializerback to summary
private final TypeDeserializer elementTypeDeserializer
keyDeserializerback to summary
private final KeyDeserializer keyDeserializer
nullProviderback to summary
private final NullValueProvider nullProvider
skipNullValuesback to summary
private final boolean skipNullValues
typeback to summary
private final MapLikeType type

Constructor Detail

GuavaCacheDeserializerback to summary
public GuavaCacheDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
GuavaCacheDeserializerback to summary
public GuavaCacheDeserializer(MapLikeType type, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer, NullValueProvider nvp)

Method Detail

_createContextualback to summary
protected abstract ValueDeserializer<?> _createContextual(MapLikeType t, KeyDeserializer kd, TypeDeserializer vtd, ValueDeserializer<?> vd, NullValueProvider np)
_tryToAddNullback to summary
protected void _tryToAddNull(JsonParser p, DeserializationContext ctxt, T cache, Object key)

Some/many Guava containers do not allow addition of null values, so isolate handling here.

Since
2.17
createCacheback to summary
protected abstract T createCache()
createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Doc from tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize 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.

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

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
@Override
deserializeContentsback to summary
private T deserializeContents(JsonParser p, DeserializationContext ctxt)
expectback to summary
private void expect(DeserializationContext context, JsonToken expected, JsonToken actual)
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