StringArrayDeserializer (jackson-databind 2.15.4)

java.lang.Object
- com.fasterxml.jackson.databind.JsonDeserializer<T>
- - com.fasterxml.jackson.databind.deser.std.StdDeserializer<String[]>
  - - com.fasterxml.jackson.databind.deser.std.StringArrayDeserializer

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, ValueInstantiator.Gettable, Serializable
```
public final class StringArrayDeserializer
extends StdDeserializer<String[]>
implements ContextualDeserializer
```
Separate implementation for serializing String arrays (instead of using ObjectArrayDeserializer. Used if (and only if) no custom value deserializers are used.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
  JsonDeserializer.None

Field Summary

Fields
Modifier and Type	Field and Description
`protected JsonDeserializer<String>`	`_elementDeserializer` Value serializer to use, if not the standard one (which is inlined)
`protected NullValueProvider`	`_nullProvider` Handler we need for dealing with null values as elements
`protected boolean`	`_skipNullValues` Marker flag set if the `_nullProvider` indicates that all null content values should be skipped (instead of being possibly converted).
`protected Boolean`	`_unwrapSingle` Specific override for this instance (from proper, or global per-type overrides) to indicate whether single value may be taken to mean an unwrapped one-element array or not.
`static StringArrayDeserializer`	`instance`

Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS

Constructor Summary

Constructors
Modifier	Constructor and Description
	`StringArrayDeserializer()`
`protected`	`StringArrayDeserializer(JsonDeserializer<?> deser, NullValueProvider nuller, Boolean unwrapSingle)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String[]`	`_deserializeCustom(JsonParser p, DeserializationContext ctxt, String[] old)` Offlined version used when we do not use the default deserialization method.
`JsonDeserializer<?>`	`createContextual(DeserializationContext ctxt, BeanProperty property)` Contextualization is needed to see whether we can "inline" deserialization of String values, or if we have to use separate value deserializer.
`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.
`String[]`	`deserialize(JsonParser p, DeserializationContext ctxt, String[] intoValue)` Alternate deserialization method (compared to the most commonly used, `JsonDeserializer.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.
`AccessPattern`	`getEmptyAccessPattern()` This method may be called in conjunction with calls to `JsonDeserializer.getEmptyValue(DeserializationContext)`, to check whether it needs to be called just once (static values), or each time empty value is needed.
`Object`	`getEmptyValue(DeserializationContext ctxt)` Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).
`LogicalType`	`logicalType()` Method for accessing logical type of values this deserializer produces.
`Boolean`	`supportsUpdate(DeserializationConfig config)` Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_byteOverflow, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _coerceBooleanFromInt, _coercedTypeDesc, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _failDoubleToIntCoercion, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isEmptyOrTextualNull, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueInstantiator, getValueType, getValueType, handledType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, findBackReference, getAbsentValue, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - instance
```
public static final StringArrayDeserializer instance
```
  - _elementDeserializer
```
protected JsonDeserializer<String> _elementDeserializer
```
    Value serializer to use, if not the standard one (which is inlined)
  - _nullProvider
```
protected final NullValueProvider _nullProvider
```
    Handler we need for dealing with null values as elements
    
    Since:
    
    2.9
  - _unwrapSingle
```
protected final Boolean _unwrapSingle
```
    Specific override for this instance (from proper, or global per-type overrides) to indicate whether single value may be taken to mean an unwrapped one-element array or not. If null, left to global defaults.
    
    Since:
    
    2.7
  - _skipNullValues
```
protected final boolean _skipNullValues
```
    Marker flag set if the _nullProvider indicates that all null content values should be skipped (instead of being possibly converted).
    
    Since:
    
    2.9
- Constructor Detail
  - StringArrayDeserializer
```
public StringArrayDeserializer()
```
  - StringArrayDeserializer
```
protected StringArrayDeserializer(JsonDeserializer<?> deser,
                                  NullValueProvider nuller,
                                  Boolean unwrapSingle)
```
- Method Detail
  - logicalType
```
public LogicalType logicalType()
```
    Description copied from class: JsonDeserializer
    
    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 JsonDeserializer<String[]>
    
    Returns:
    
    Logical type of values this deserializer produces, if known; null if not
  - supportsUpdate
```
public Boolean supportsUpdate(DeserializationConfig config)
```
    Description copied from class: JsonDeserializer
    
    Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not. Return value should either be Boolean.FALSE if update is not supported at all (immutable values); Boolean.TRUE if update should usually work (regular POJOs, for example), or null if this is either not known, or may sometimes work.
    Information gathered is typically used to either prevent merging update for property (either by skipping, if based on global defaults; or by exception during deserializer construction if explicit attempt made) if Boolean.FALSE returned, or inclusion if Boolean.TRUE is specified. If "unknown" case (null returned) behavior is to exclude property if global defaults used; or to allow if explicit per-type or property merging is defined.
    Default implementation returns null to allow explicit per-type or per-property attempts.
    
    Overrides:
    
    supportsUpdate in class JsonDeserializer<String[]>
  - getEmptyAccessPattern
```
public AccessPattern getEmptyAccessPattern()
```
    Description copied from class: JsonDeserializer
    
    This method may be called in conjunction with calls to JsonDeserializer.getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.
    
    Overrides:
    
    getEmptyAccessPattern in class JsonDeserializer<String[]>
  - getEmptyValue
```
public Object getEmptyValue(DeserializationContext ctxt)
                     throws JsonMappingException
```
    Description copied from class: JsonDeserializer
    
    Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) (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 JsonDeserializer.getEmptyAccessPattern() returns.
    Default implementation simply calls JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) and returns value.
    
    Overrides:
    
    getEmptyValue in class JsonDeserializer<String[]>
    
    Throws:
    
    JsonMappingException
  - createContextual
```
public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException
```
    Contextualization is needed to see whether we can "inline" deserialization of String values, or if we have to use separate value deserializer.
    
    Specified by:
    
    createContextual in interface ContextualDeserializer
    
    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.
    
    Throws:
    
    JsonMappingException
  - deserialize
```
public String[] deserialize(JsonParser p,
                            DeserializationContext ctxt)
                     throws IOException
```
    Description copied from class: JsonDeserializer
    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).
    Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.
    Specified by:
    
    deserialize in class JsonDeserializer<String[]>
    
    Parameters:
    
    p - Parsed used for reading JSON content
    
    ctxt - Context that can be used to access information about this deserialization activity.
    
    Returns:
    
    Deserialized value
    
    Throws:
    
    IOException
  - _deserializeCustom
```
protected final String[] _deserializeCustom(JsonParser p,
                                            DeserializationContext ctxt,
                                            String[] old)
                                     throws IOException
```
    Offlined version used when we do not use the default deserialization method.
    
    Throws:
    
    IOException
  - deserializeWithType
```
public Object deserializeWithType(JsonParser p,
                                  DeserializationContext ctxt,
                                  TypeDeserializer typeDeserializer)
                           throws IOException
```
    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<String[]>
    
    typeDeserializer - Deserializer to use for handling type information
    
    Throws:
    
    IOException
  - deserialize
```
public String[] deserialize(JsonParser p,
                            DeserializationContext ctxt,
                            String[] intoValue)
                     throws IOException
```
    Description copied from class: JsonDeserializer
    
    Alternate deserialization method (compared to the most commonly used, JsonDeserializer.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 JsonDeserializer<String[]>
    
    Throws:
    
    IOException

Class StringArrayDeserializer

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

Methods inherited from class java.lang.Object

Field Detail

instance

_elementDeserializer

_nullProvider

_unwrapSingle

_skipNullValues

Constructor Detail

StringArrayDeserializer

StringArrayDeserializer

Method Detail

logicalType

supportsUpdate

getEmptyAccessPattern

getEmptyValue

createContextual

deserialize

_deserializeCustom

deserializeWithType

deserialize