Class BeanAsArrayBuilderDeserializer
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ResolvableDeserializer
,ValueInstantiator.Gettable
,Serializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
Field Summary
Modifier and TypeFieldDescriptionprotected final AnnotatedMethod
protected final BeanDeserializerBase
Deserializer we delegate operations that we cannot handle.protected final SettableBeanProperty[]
Properties in order expected to be found in JSON array.protected final JavaType
Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.BeanDeserializerBase
_anySetter, _arrayDelegateDeserializer, _backRefs, _beanProperties, _beanType, _delegateDeserializer, _externalTypeIdHandler, _ignorableProps, _ignoreAllUnknown, _includableProps, _injectables, _needViewProcesing, _nonStandardCreation, _objectIdReader, _propertyBasedCreator, _serializationShape, _subDeserializers, _unwrappedPropertyHandler, _valueInstantiator, _vanillaProcessing, TEMP_PROPERTY_NAME
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
-
Constructor Summary
ConstructorDescriptionBeanAsArrayBuilderDeserializer
(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 Object
protected Object
Alternate deserialization method that has to check many more configuration aspects than the "vanilla" processing.protected final Object
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.protected BeanDeserializerBase
Fluent 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,JsonDeserializer.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 Object
finishBuild
(DeserializationContext ctxt, Object builder) supportsUpdate
(DeserializationConfig config) Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.unwrappingDeserializer
(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 edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.BeanDeserializerBase
_convertObjectId, _delegateDeserializer, _findPropertyUnwrapper, _findSubclassDeserializer, _handleByNameInclusion, _handleTypedObjectId, _replaceProperty, _resolvedObjectIdProperty, _resolveInnerClassValuedProperty, _resolveManagedReferenceProperty, _resolveMergeAndNullSettings, createContextual, creatorProperties, deserializeFromArray, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromObjectId, deserializeFromObjectUsingNonDefault, deserializeFromString, deserializeWithObjectId, deserializeWithType, findBackReference, findConvertingDeserializer, findProperty, findProperty, findProperty, getBeanClass, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, handleIgnoredProperty, handlePolymorphic, handleUnknownProperties, handleUnknownProperty, handleUnknownVanilla, hasProperty, hasViews, injectValues, isCachable, isCaseInsensitive, logicalType, properties, replaceProperty, resolve, withIgnorableProperties, wrapAndThrow, wrapInstantiationProblem
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.StdDeserializer
_byteOverflow, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _coerceBooleanFromInt, _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, getValueType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, isDefaultDeserializer, isDefaultKeyDeserializer
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, getAbsentValue, getDelegatee, getEmptyValue, getNullValue, 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.- Since:
- 2.9
-
-
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.- Since:
- 2.9
-
-
Method Details
-
unwrappingDeserializer
Description copied from class:JsonDeserializer
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.Default implementation just returns 'this' indicating that no unwrapped variant exists
- Specified by:
unwrappingDeserializer
in classBeanDeserializerBase
-
withObjectIdReader
- Specified by:
withObjectIdReader
in classBeanDeserializerBase
-
withByNameInclusion
public BeanDeserializerBase withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps) - Specified by:
withByNameInclusion
in classBeanDeserializerBase
-
withIgnoreAllUnknown
- Specified by:
withIgnoreAllUnknown
in classBeanDeserializerBase
-
withBeanProperties
Description copied from class:BeanDeserializerBase
Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.- Overrides:
withBeanProperties
in classBeanDeserializerBase
-
asArrayDeserializer
Description copied from class:BeanDeserializerBase
Fluent 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:
asArrayDeserializer
in classBeanDeserializerBase
-
supportsUpdate
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 beBoolean.FALSE
if update is not supported at all (immutable values);Boolean.TRUE
if update should usually work (regular POJOs, for example), ornull
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 ifBoolean.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 classBeanDeserializerBase
-
finishBuild
- Throws:
IOException
-
deserialize
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 classJsonDeserializer<Object>
- Parameters:
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
IOException
-
deserialize
public Object deserialize(JsonParser p, DeserializationContext ctxt, Object value) 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 classJsonDeserializer<Object>
- Throws:
IOException
-
deserializeFromObject
Description copied from class:BeanDeserializerBase
General version used when handling needs more advanced features.- Specified by:
deserializeFromObject
in classBeanDeserializerBase
- Throws:
IOException
-
_deserializeNonVanilla
protected Object _deserializeNonVanilla(JsonParser p, DeserializationContext ctxt) throws IOException 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:
IOException
-
_deserializeUsingPropertyBased
protected final Object _deserializeUsingPropertyBased(JsonParser p, DeserializationContext ctxt) throws IOException 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:
_deserializeUsingPropertyBased
in classBeanDeserializerBase
- Throws:
IOException
-
_deserializeFromNonArray
protected Object _deserializeFromNonArray(JsonParser p, DeserializationContext ctxt) throws IOException - Throws:
IOException
-