Module tools.jackson.databind

Package tools.jackson.databind.deser.jdk

Class StringCollectionDeserializer

java.lang.Object

tools.jackson.databind.ValueDeserializer<T>

tools.jackson.databind.deser.std.StdDeserializer<T>

tools.jackson.databind.deser.std.ContainerDeserializerBase<Collection<String>>

tools.jackson.databind.deser.jdk.StringCollectionDeserializer

All Implemented Interfaces:

NullValueProvider, ValueInstantiator.Gettable

public final class StringCollectionDeserializer
extends ContainerDeserializerBase<Collection<String>>

Specifically optimized version for Collections that contain String values; reason is that this is a very common type and we can make use of the fact that Strings are final.

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueDeserializer

ValueDeserializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedClass	_classInfo	Annotations defined on the actual Collection class; retained to avoid re-introspection overhead during createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) calls.

Fields inherited from class tools.jackson.databind.deser.std.ContainerDeserializerBase

_containerType, _nullProvider, _skipNullValues, _unwrapSingle

Fields inherited from class tools.jackson.databind.deser.std.StdDeserializer

_valueClass, _valueType, F_MASK_INT_COERCIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringCollectionDeserializer(JavaType collectionType, ValueInstantiator valueInstantiator, ValueDeserializer<?> delegateDeser, ValueDeserializer<?> valueDeser, NullValueProvider nuller, Boolean unwrapSingle, AnnotatedClass classInfo)
	StringCollectionDeserializer(JavaType collectionType, ValueDeserializer<?> valueDeser, ValueInstantiator valueInstantiator, AnnotatedClass classInfo)

Method Summary

Modifier and Type	Method	Description
static StringCollectionDeserializer	create(JavaType collectionType, BeanDescription.Supplier beanDescRef, ValueDeserializer<Object> valueDeser, ValueInstantiator valueInstantiator)	Factory method called by BasicDeserializerFactory to create an instance
ValueDeserializer<?>	createContextual(DeserializationContext ctxt, BeanProperty property)	Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
Collection<String>	deserialize(JsonParser p, DeserializationContext ctxt)	Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Collection<String>	deserialize(JsonParser p, DeserializationContext ctxt, Collection<String> result)	Alternate deserialization method (compared to the most commonly used, ValueDeserializer.deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.
Object	deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)	Base implementation that does not assume specific type inclusion mechanism.
ValueDeserializer<Object>	getContentDeserializer()	Accesor for deserializer use for deserializing content values.
ValueInstantiator	getValueInstantiator()
boolean	isCachable()	Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).
LogicalType	logicalType()	Method for accessing logical type of values this deserializer produces.
protected StringCollectionDeserializer	withResolved(ValueDeserializer<?> delegateDeser, ValueDeserializer<?> valueDeser, NullValueProvider nuller, Boolean unwrapSingle)

Methods inherited from class tools.jackson.databind.deser.std.ContainerDeserializerBase

findBackReference, getContentType, getEmptyAccessPattern, getEmptyValue, getValueType, supportsUpdate, wrapAndThrow

Methods inherited from class 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, _deserializeFromStringForContainer, _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, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _wrapIOFailure, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatFeature, findFormatOverrides, findFormatOverrides, findValueNullProvider, getValueType, handledType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer

Methods inherited from class tools.jackson.databind.ValueDeserializer

deserializeWithType, getAbsentValue, getDelegatee, getKnownPropertyNames, getNullAccessPattern, getNullValue, getObjectIdReader, replaceDelegatee, resolve, unwrappingDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_classInfo

protected final transient AnnotatedClass _classInfo

Annotations defined on the actual Collection class; retained to avoid re-introspection overhead during createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) calls.

Since:

3.1

Constructor Details

StringCollectionDeserializer

public StringCollectionDeserializer(JavaType collectionType,
 ValueDeserializer<?> valueDeser,
 ValueInstantiator valueInstantiator,
 AnnotatedClass classInfo)

StringCollectionDeserializer

protected StringCollectionDeserializer(JavaType collectionType,
 ValueInstantiator valueInstantiator,
 ValueDeserializer<?> delegateDeser,
 ValueDeserializer<?> valueDeser,
 NullValueProvider nuller,
 Boolean unwrapSingle,
 AnnotatedClass classInfo)

Method Details

create

public static StringCollectionDeserializer create(JavaType collectionType,
 BeanDescription.Supplier beanDescRef,
 ValueDeserializer<Object> valueDeser,
 ValueInstantiator valueInstantiator)

Factory method called by BasicDeserializerFactory to create an instance

Since:

3.1

withResolved

protected StringCollectionDeserializer withResolved(ValueDeserializer<?> delegateDeser,
 ValueDeserializer<?> valueDeser,
 NullValueProvider nuller,
 Boolean unwrapSingle)

isCachable

public boolean isCachable()

Description copied from class: ValueDeserializer

Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).

Note that cached instances are still contextualized on per-property basis (but note that ValueDeserializer.resolve(DeserializationContext)d just once!) This means that in most cases it is safe to cache instances; however, it only makes sense to cache instances if instantiation is expensive, or if instances are heavy-weight.

Default implementation returns false, to indicate that no caching is done.

Overrides:

isCachable in class ValueDeserializer<Collection<String>>

logicalType

public LogicalType logicalType()

Description copied from class: ValueDeserializer

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.

Overrides:

logicalType in class ValueDeserializer<Collection<String>>

Returns:

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

createContextual

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

Description copied from class: ValueDeserializer

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.

Overrides:

createContextual in class ValueDeserializer<Collection<String>>

Parameters:

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

property - 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:

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

getContentDeserializer

public ValueDeserializer<Object> getContentDeserializer()

Description copied from class: ContainerDeserializerBase

Accesor for deserializer use for deserializing content values.

Specified by:

getContentDeserializer in class ContainerDeserializerBase<Collection<String>>

getValueInstantiator

public ValueInstantiator getValueInstantiator()

Specified by:

getValueInstantiator in interface ValueInstantiator.Gettable

Overrides:

getValueInstantiator in class StdDeserializer<Collection<String>>

deserialize

public Collection<String> deserialize(JsonParser p,
 DeserializationContext ctxt)
                               throws JacksonException

Description copied from class: ValueDeserializer

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().

Specified by:

deserialize in class ValueDeserializer<Collection<String>>

Parameters:

p - Parser used for reading JSON content

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

Returns:

Deserialized value

Throws:

JacksonException

deserialize

public Collection<String> deserialize(JsonParser p,
 DeserializationContext ctxt,
 Collection<String> result)
                               throws JacksonException

Description copied from class: ValueDeserializer

Alternate deserialization method (compared to the most commonly used, ValueDeserializer.deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used (or supported) by all types (it will not work for immutable types, for obvious reasons): most commonly it is used for Collections and Maps. It may be used both with "updating readers" (for POJOs) and when Collections and Maps use "getter as setter".

Default implementation just throws UnsupportedOperationException, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types)

Overrides:

deserialize in class ValueDeserializer<Collection<String>>

Throws:

JacksonException

deserializeWithType

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

Description copied from class: StdDeserializer

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.

Overrides:

deserializeWithType in class StdDeserializer<Collection<String>>

typeDeserializer - Deserializer to use for handling type information

Throws:

JacksonException