Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.deser.std

public final Class StringArrayDeserializer

extends StdDeserializer<String[]>
implements ContextualDeserializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.deser.ContextualDeserializer
Annotations
@JacksonStdImpl
Imports
java.io.IOException, java.util.Objects, com.fasterxml.jackson.annotation.JsonFormat, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.annotation.JacksonStdImpl, com.fasterxml.jackson.databind.cfg.CoercionAction, .CoercionInputShape, com.fasterxml.jackson.databind.deser.ContextualDeserializer, .NullValueProvider, com.fasterxml.jackson.databind.deser.impl.NullsConstantProvider, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.databind.type.LogicalType, com.fasterxml.jackson.databind.util.AccessPattern, .ObjectBuffer

Separate implementation for serializing String arrays (instead of using ObjectArrayDeserializer. Used if (and only if) no custom value deserializers are used.

Field Summary

Modifier and TypeField and Description
protected JsonDeserializer<String>
_elementDeserializer

Value serializer to use, if not the standard one (which is inlined)

protected final NullValueProvider
_nullProvider

Handler we need for dealing with null values as elements

protected final boolean
_skipNullValues

Marker flag set if the _nullProvider indicates that all null content values should be skipped (instead of being possibly converted).

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.

public static final StringArrayDeserializer
private static final String[]
private static final long
Inherited from com.fasterxml.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_ACCEPT_ARRAYSF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
public
protected

Method Summary

Modifier and TypeMethod and Description
protected final String[]
_deserializeCustom(JsonParser p, DeserializationContext ctxt, String[] old)

Offlined version used when we do not use the default deserialization method.

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.

Contextualization is needed to see whether we can "inline" deserialization of String values, or if we have to use separate value deserializer.

public String[]
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 String[]
deserialize(JsonParser p, DeserializationContext ctxt, String[] intoValue)

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

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 AccessPattern
getEmptyAccessPattern()

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

public Object
getEmptyValue(DeserializationContext ctxt)

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

private final String[]
public LogicalType
logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

public Boolean
supportsUpdate(DeserializationConfig config)

Overrides com.fasterxml.jackson.databind.JsonDeserializer.supportsUpdate.

Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.

Inherited from 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_verifyStringForScalarCoercionfindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueClassgetValueInstantiatorgetValueTypegetValueTypehandledTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Field Detail

_elementDeserializerback to summary
protected JsonDeserializer<String> _elementDeserializer

Value serializer to use, if not the standard one (which is inlined)

_nullProviderback to summary
protected final NullValueProvider _nullProvider

Handler we need for dealing with null values as elements

Since
2.9
_skipNullValuesback to summary
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
_unwrapSingleback to summary
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
instanceback to summary
public static final StringArrayDeserializer instance
NO_STRINGSback to summary
private static final String[] NO_STRINGS
serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

StringArrayDeserializerback to summary
public StringArrayDeserializer()
StringArrayDeserializerback to summary
protected StringArrayDeserializer(JsonDeserializer<?> deser, NullValueProvider nuller, Boolean unwrapSingle)
Annotations
@SuppressWarnings:unchecked

Method Detail

_deserializeCustomback to summary
protected final String[] _deserializeCustom(JsonParser p, DeserializationContext ctxt, String[] old) throws IOException

Offlined version used when we do not use the default deserialization method.

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

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

Contextualization is needed to see whether we can "inline" deserialization of String values, or if we have to use separate value deserializer.

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 String[] 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:String[]

Deserialized value

Annotations
@Override
deserializeback to summary
public String[] deserialize(JsonParser p, DeserializationContext ctxt, String[] intoValue) throws IOException

Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

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

Doc from 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
getEmptyAccessPatternback to summary
public AccessPattern getEmptyAccessPattern()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.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 Object getEmptyValue(DeserializationContext ctxt) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.JsonDeserializer.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
handleNonArrayback to summary
private final String[] handleNonArray(JsonParser p, DeserializationContext ctxt) throws IOException
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
supportsUpdateback to summary
public Boolean supportsUpdate(DeserializationConfig config)

Overrides com.fasterxml.jackson.databind.JsonDeserializer.supportsUpdate.

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

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.

Annotations
@Override