Top Description Fields Constructors Methods
tools.jackson.databind.deser.jdk

public final Class StringCollectionDeserializer

extends ContainerDeserializerBase<Collection<String>>
Class Inheritance
Annotations
@JacksonStdImpl
Imports
java.util.*, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.annotation.JacksonStdImpl, tools.jackson.databind.cfg.CoercionAction, .CoercionInputShape, tools.jackson.databind.deser.NullValueProvider, .ValueInstantiator, tools.jackson.databind.deser.std.ContainerDeserializerBase, tools.jackson.databind.introspect.AnnotatedWithParams, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType

Specifically optimized version for java.util.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.

Field Summary

Modifier and TypeField and Description
private final ValueDeserializer<Object>
_delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

private final ValueDeserializer<String>
_valueDeserializer

Value deserializer to use, if NOT the standard one (if it is, will be null).

private final ValueInstantiator
_valueInstantiator

Instantiator used in case custom handling is needed for creation.

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

Constructor Summary

AccessConstructor and Description
public
StringCollectionDeserializer(JavaType collectionType, ValueDeserializer<?> valueDeser, ValueInstantiator valueInstantiator)

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

Method Summary

Modifier and TypeMethod and Description
private static Collection<String>
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 Collection<String>
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 Collection<String>
deserialize(JsonParser p, DeserializationContext ctxt, Collection<String> result)

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.

private Collection<String>
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 ValueInstantiator
private final Collection<String>
handleNonArray(JsonParser p, DeserializationContext ctxt, Collection<String> result)

Helper method called when current token is not START_ARRAY.

public boolean
isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

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

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

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

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

Field Detail

_delegateDeserializerback to summary
private final ValueDeserializer<Object> _delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

_valueDeserializerback to summary
private final ValueDeserializer<String> _valueDeserializer

Value deserializer to use, if NOT the standard one (if it is, will be null).

_valueInstantiatorback to summary
private final ValueInstantiator _valueInstantiator

Instantiator used in case custom handling is needed for creation.

Constructor Detail

StringCollectionDeserializerback to summary
public StringCollectionDeserializer(JavaType collectionType, ValueDeserializer<?> valueDeser, ValueInstantiator valueInstantiator)
StringCollectionDeserializerback to summary
protected StringCollectionDeserializer(JavaType collectionType, ValueInstantiator valueInstantiator, ValueDeserializer<?> delegateDeser, ValueDeserializer<?> valueDeser, NullValueProvider nuller, Boolean unwrapSingle)
Annotations
@SuppressWarnings:unchecked

Method Detail

castToCollectionback to summary
private static Collection<String> castToCollection(Object o)
Annotations
@SuppressWarnings:unchecked
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 Collection<String> 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
@Override
deserializeback to summary
public Collection<String> deserialize(JsonParser p, DeserializationContext ctxt, Collection<String> result) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, 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)

Annotations
@Override
deserializeUsingCustomback to summary
private Collection<String> deserializeUsingCustom(JsonParser p, DeserializationContext ctxt, Collection<String> result, final ValueDeserializer<String> deser) throws JacksonException
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

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

Doc from 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
getValueInstantiatorback to summary
public ValueInstantiator getValueInstantiator()

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

Implements tools.jackson.databind.deser.ValueInstantiator.Gettable.getValueInstantiator.

Annotations
@Override
handleNonArrayback to summary
private final Collection<String> handleNonArray(JsonParser p, DeserializationContext ctxt, Collection<String> result) throws JacksonException

Helper method called when current token is not START_ARRAY. Will either throw an exception, or try to handle value as if member of implicit array, depending on configuration.

isCachableback to summary
public boolean isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Doc from tools.jackson.databind.ValueDeserializer.isCachable.

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.

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
protected StringCollectionDeserializer withResolved(ValueDeserializer<?> delegateDeser, ValueDeserializer<?> valueDeser, NullValueProvider nuller, Boolean unwrapSingle)