Class BeanAsArrayBuilderDeserializer
- All Implemented Interfaces:
NullValueProvider,ValueInstantiator.Gettable
-
Nested Class Summary
Nested classes/interfaces inherited from class tools.jackson.databind.ValueDeserializer
ValueDeserializer.None -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final AnnotatedMethodprotected final BeanDeserializerBaseDeserializer we delegate operations that we cannot handle.protected final SettableBeanProperty[]Properties in order expected to be found in JSON array.protected final JavaTypeType that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.Fields inherited from class tools.jackson.databind.deser.bean.BeanDeserializerBase
_anySetter, _arrayDelegateDeserializer, _backRefs, _beanProperties, _beanType, _delegateDeserializer, _externalTypeIdHandler, _ignorableProps, _ignoreAllUnknown, _includableProps, _injectables, _needViewProcesing, _nonStandardCreation, _objectIdReader, _propertyBasedCreator, _serializationShape, _subDeserializers, _unwrappedPropertyHandler, _valueInstantiator, _vanillaProcessing, TEMP_PROPERTY_NAMEFields inherited from class tools.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_INT_COERCIONS -
Constructor Summary
ConstructorsConstructorDescriptionBeanAsArrayBuilderDeserializer(BeanDeserializerBase delegate, JavaType targetType, SettableBeanProperty[] ordered, AnnotatedMethod buildMethod) Main constructor used both for creating new instances (byBeanDeserializer.asArrayDeserializer()) and for creating copies with different delegate. -
Method Summary
Modifier and TypeMethodDescriptionprotected Objectprotected ObjectAlternate deserialization method that has to check many more configuration aspects than the "vanilla" processing.protected final ObjectMethod called to deserialize bean using "property-based creator": this means that a non-default constructor or factory method is called, and then possibly other setters.protected BeanDeserializerBaseFluent factory for creating a variant that can handle POJO output as a JSON Array.deserialize(JsonParser p, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.deserialize(JsonParser p, DeserializationContext ctxt, Object value) 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.General version used when handling needs more advanced features.protected final ObjectfinishBuild(DeserializationContext ctxt, Object builder) protected voidsupportsUpdate(DeserializationConfig config) Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.unwrappingDeserializer(DeserializationContext ctxt, NameTransformer unwrapper) Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps) withIgnoreAllUnknown(boolean ignoreUnknown) Methods inherited from class tools.jackson.databind.deser.bean.BeanDeserializerBase
_convertObjectId, _delegateDeserializer, _delegateDeserializer, _findConvertingDeserializer, _findPropertyUnwrapper, _findSubclassDeserializer, _getSetterInfo, _handleByNameInclusion, _handleTypedObjectId, _replaceProperty, _resolvedObjectIdProperty, _resolveInnerClassValuedProperty, _resolveManagedReferenceProperty, _resolveMergeAndNullSettings, createContextual, creatorProperties, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromObjectId, deserializeFromObjectUsingNonDefault, deserializeFromString, deserializeWithObjectId, deserializeWithType, findBackReference, findProperty, findProperty, findProperty, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, handleIgnoredProperty, handlePolymorphic, handleUnknownProperties, handleUnknownProperty, handleUnknownVanilla, hasProperty, hasViews, injectValues, isCachable, isCaseInsensitive, logicalType, properties, resolve, wrapAndThrow, wrapInstantiationProblemMethods 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, _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, _verifyNullForPrimitiveCoercion, _wrapIOFailure, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, isDefaultDeserializer, isDefaultKeyDeserializerMethods inherited from class tools.jackson.databind.ValueDeserializer
deserializeWithType, getAbsentValue, getDelegatee, getNullValue, replaceDelegatee
-
Field Details
-
_delegate
Deserializer we delegate operations that we cannot handle. -
_orderedProperties
Properties in order expected to be found in JSON array. -
_buildMethod
-
_targetType
Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.
-
-
Constructor Details
-
BeanAsArrayBuilderDeserializer
public BeanAsArrayBuilderDeserializer(BeanDeserializerBase delegate, JavaType targetType, SettableBeanProperty[] ordered, AnnotatedMethod buildMethod) Main constructor used both for creating new instances (byBeanDeserializer.asArrayDeserializer()) and for creating copies with different delegate.
-
-
Method Details
-
unwrappingDeserializer
public ValueDeserializer<Object> unwrappingDeserializer(DeserializationContext ctxt, NameTransformer unwrapper) Description copied from class:ValueDeserializerMethod that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.Default implementation just returns 'this' indicating that no unwrapped variant exists
- Specified by:
unwrappingDeserializerin classBeanDeserializerBase
-
withObjectIdReader
- Specified by:
withObjectIdReaderin classBeanDeserializerBase
-
withByNameInclusion
public BeanDeserializerBase withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps) - Specified by:
withByNameInclusionin classBeanDeserializerBase
-
withIgnoreAllUnknown
- Specified by:
withIgnoreAllUnknownin classBeanDeserializerBase
-
withBeanProperties
Description copied from class:BeanDeserializerBaseMutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.- Overrides:
withBeanPropertiesin classBeanDeserializerBase
-
asArrayDeserializer
Description copied from class:BeanDeserializerBaseFluent factory for creating a variant that can handle POJO output as a JSON Array. Implementations may ignore this request if no such input is possible.- Specified by:
asArrayDeserializerin classBeanDeserializerBase
-
initNameMatcher
- Specified by:
initNameMatcherin classBeanDeserializerBase
-
supportsUpdate
Description copied from class:ValueDeserializerIntrospection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not. Return value should either beBoolean.FALSEif update is not supported at all (immutable values);Boolean.TRUEif update should usually work (regular POJOs, for example), ornullif 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.FALSEreturned, or inclusion ifBoolean.TRUEis specified. If "unknown" case (nullreturned) behavior is to exclude property if global defaults used; or to allow if explicit per-type or property merging is defined.Default implementation returns
nullto allow explicit per-type or per-property attempts.- Overrides:
supportsUpdatein classBeanDeserializerBase
-
finishBuild
protected final Object finishBuild(DeserializationContext ctxt, Object builder) throws JacksonException - Throws:
JacksonException
-
deserialize
Description copied from class:ValueDeserializerMethod 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@classfield 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 JSONnullliteral to avoid every deserializer from having to handle null values. Instead, theValueDeserializer.getNullValue(DeserializationContext)method is called to produce a null value. To influence null handling, custom deserializers should overrideValueDeserializer.getNullValue(DeserializationContext)and usually alsoValueDeserializer.getNullAccessPattern().- Specified by:
deserializein classValueDeserializer<Object>- Parameters:
p- Parser used for reading JSON contentctxt- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
JacksonException
-
deserialize
public Object deserialize(JsonParser p, DeserializationContext ctxt, Object value) throws JacksonException Description copied from class:ValueDeserializerAlternate 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:
deserializein classValueDeserializer<Object>- Throws:
JacksonException
-
deserializeFromObject
public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws JacksonException Description copied from class:BeanDeserializerBaseGeneral version used when handling needs more advanced features.- Specified by:
deserializeFromObjectin classBeanDeserializerBase- Throws:
JacksonException
-
_deserializeNonVanilla
protected Object _deserializeNonVanilla(JsonParser p, DeserializationContext ctxt) throws JacksonException Alternate deserialization method that has to check many more configuration aspects than the "vanilla" processing. Note: should NOT resolve builder; caller will do that- Returns:
- Builder object in use.
- Throws:
JacksonException
-
_deserializeUsingPropertyBased
protected final Object _deserializeUsingPropertyBased(JsonParser p, DeserializationContext ctxt) throws JacksonException Method called to deserialize bean using "property-based creator": this means that a non-default constructor or factory method is called, and then possibly other setters. The trick is that values for creator method need to be buffered, first; and due to non-guaranteed ordering possibly some other properties as well.- Specified by:
_deserializeUsingPropertyBasedin classBeanDeserializerBase- Throws:
JacksonException
-
_deserializeFromNonArray
protected Object _deserializeFromNonArray(JsonParser p, DeserializationContext ctxt) throws JacksonException - Throws:
JacksonException
-