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

public abstract Class GuavaCollectionDeserializer<T>

extends ContainerDeserializerBase<T>
Class Inheritance
Known Direct Subclasses
tools.jackson.datatype.guava.deser.GuavaImmutableCollectionDeserializer, tools.jackson.datatype.guava.deser.GuavaMultisetDeserializer
Imports
java.util.Collection, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.deser.NullValueProvider, tools.jackson.databind.deser.std.ContainerDeserializerBase, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType, tools.jackson.databind.util.AccessPattern, .ClassUtil

Base class for Guava-specific collection deserializers.

Field Summary

Modifier and TypeField and Description
protected final ValueDeserializer<?>
_valueDeserializer

Deserializer used for values contained in collection being deserialized; either assigned on constructor, or during resolve().

protected final TypeDeserializer
_valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can deserialize required type information

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
_containerType_nullProvider_skipNullValues_unwrapSingle

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
protected abstract T
protected abstract T
protected abstract T
protected T
_deserializeFromSingleValue(JsonParser p, DeserializationContext ctxt)

Method used to support implicit coercion from a single non-array value into single-element collection.

protected void
_tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set)

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

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

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, after deserializer itself has been registered.

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.

public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public ValueDeserializer<Object>
getContentDeserializer()

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

public abstract AccessPattern
getEmptyAccessPattern()

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyAccessPattern.

This method may be called in conjunction with calls to getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

public abstract Object
getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

public abstract GuavaCollectionDeserializer<T>
withResolved(ValueDeserializer<?> valueDeser, TypeDeserializer typeDeser, NullValueProvider nuller, Boolean unwrapSingle)

Overridable fluent factory method used for creating contextual instances.

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetContentTypegetValueTypesupportsUpdatewrapAndThrow

Field Detail

_valueDeserializerback to summary
protected final ValueDeserializer<?> _valueDeserializer

Deserializer used for values contained in collection being deserialized; either assigned on constructor, or during resolve().

_valueTypeDeserializerback to summary
protected final TypeDeserializer _valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can deserialize required type information

Constructor Detail

GuavaCollectionDeserializerback to summary
protected GuavaCollectionDeserializer(JavaType selfType, ValueDeserializer<?> deser, TypeDeserializer typeDeser, NullValueProvider nuller, Boolean unwrapSingle)

Method Detail

_createEmptyback to summary
protected abstract T _createEmpty(DeserializationContext ctxt)
_createWithSingleElementback to summary
protected abstract T _createWithSingleElement(DeserializationContext ctxt, Object value)
_deserializeContentsback to summary
protected abstract T _deserializeContents(JsonParser p, DeserializationContext ctxt) throws JacksonException
_deserializeFromSingleValueback to summary
protected T _deserializeFromSingleValue(JsonParser p, DeserializationContext ctxt) throws JacksonException

Method used to support implicit coercion from a single non-array value into single-element collection.

_tryToAddNullback to summary
protected void _tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set)

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

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

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, after deserializer itself has been registered. This is needed to handle recursive and transitive dependencies.

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
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Annotations
@Override
getContentDeserializerback to summary
public ValueDeserializer<Object> getContentDeserializer()

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

Annotations
@SuppressWarnings:unchecked
@Override
getEmptyAccessPatternback to summary
public abstract AccessPattern getEmptyAccessPattern()

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyAccessPattern.

Doc from tools.jackson.databind.ValueDeserializer.getEmptyAccessPattern.

This method may be called in conjunction with calls to getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

Annotations
@Override
getEmptyValueback to summary
public abstract Object getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyValue.

Doc from tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as getNullValue (which in turn is usually simply Java null), but it can be overridden for specific types. Or, if type should never be converted from empty String, method can also throw an exception.

This method may be called once, or multiple times, depending on what getEmptyAccessPattern() returns.

Default implementation simply calls getNullValue and returns value.

Annotations
@Override
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
withResolvedback to summary
public abstract GuavaCollectionDeserializer<T> withResolved(ValueDeserializer<?> valueDeser, TypeDeserializer typeDeser, NullValueProvider nuller, Boolean unwrapSingle)

Overridable fluent factory method used for creating contextual instances.