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

public abstract Class GuavaCollectionDeserializer<T>

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

Base class for Guava-specific collection deserializers.

Field Summary

Modifier and TypeField and Description
protected final JsonDeserializer<?>
_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

private static final long
Inherited from com.fasterxml.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 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.

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

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.

public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information
typeDeserializer
)

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public JsonDeserializer<Object>
getContentDeserializer()

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

public abstract AccessPattern
getEmptyAccessPattern()

Overrides com.fasterxml.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 com.fasterxml.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 com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

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

Overridable fluent factory method used for creating contextual instances.

Inherited from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetContentTypegetValueTypesupportsUpdatewrapAndThrowwrapAndThrow

Field Detail

_valueDeserializerback to summary
protected final JsonDeserializer<?> _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

serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

GuavaCollectionDeserializerback to summary
protected GuavaCollectionDeserializer(JavaType selfType, JsonDeserializer<?> 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 IOException
_deserializeFromSingleValueback to summary
protected T _deserializeFromSingleValue(JsonParser p, DeserializationContext ctxt) throws IOException

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

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

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

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

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

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

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
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
@SuppressWarnings:unchecked
@Override
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

Overrides com.fasterxml.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.

Parameters
typeDeserializer:TypeDeserializer

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

Deserializer to use for handling type information

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

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from com.fasterxml.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 com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyAccessPattern.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyValue.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 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
withResolvedback to summary
public abstract GuavaCollectionDeserializer<T> withResolved(JsonDeserializer<?> valueDeser, TypeDeserializer typeDeser, NullValueProvider nuller, Boolean unwrapSingle)

Overridable fluent factory method used for creating contextual instances.