Class BuilderBasedDeserializer
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ResolvableDeserializer
,ValueInstantiator.Gettable
,Serializable
Note on implementation: much of code has been copied from
BeanDeserializer
; there may be opportunities to
refactor this in future.
- 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 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
ModifierConstructorDescriptionBuilderBasedDeserializer
(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews) Deprecated.Since 2.9BuilderBasedDeserializer
(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews) Constructor used byBeanDeserializerBuilder
.BuilderBasedDeserializer
(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps, boolean hasViews) protected
Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.protected
BuilderBasedDeserializer
(BuilderBasedDeserializer src, boolean ignoreAllUnknown) protected
BuilderBasedDeserializer
(BuilderBasedDeserializer src, NameTransformer unwrapper) BuilderBasedDeserializer
(BuilderBasedDeserializer src, Set<String> ignorableProps) BuilderBasedDeserializer
(BuilderBasedDeserializer src, Set<String> ignorableProps, Set<String> includableProps) -
Method Summary
Modifier and TypeMethodDescriptionprotected final Object
_deserialize
(JsonParser p, DeserializationContext ctxt, Object builder) protected Object
Helper method that allows easy support for array-related coercion features: checks for either empty array, or single-value array-wrapped value (if coercion enabled byCoercionConfigs
(since 2.12), and either reports an exception (if no coercion allowed), or returns appropriate result value using coercion mechanism indicated.protected 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) Main deserialization method for bean-based objects (POJOs).deserialize
(JsonParser p, DeserializationContext ctxt, Object value) Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.General version used when handling needs more advanced features.protected Object
protected Object
protected Object
protected Object
deserializeWithExternalTypeId
(JsonParser p, DeserializationContext ctxt, Object bean) protected Object
Method called when there are declared "unwrapped" properties which need special handlingprotected Object
deserializeWithUnwrapped
(JsonParser p, DeserializationContext ctxt, Object builder, TokenBuffer tokens) protected final Object
deserializeWithView
(JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView) protected 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, _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
-
_buildMethod
-
_targetType
Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.- Since:
- 2.9
-
-
Constructor Details
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews) Constructor used byBeanDeserializerBuilder
. -
BuilderBasedDeserializer
public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps, boolean hasViews) - Since:
- 2.12
-
BuilderBasedDeserializer
@Deprecated public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews) Deprecated.Since 2.9 -
BuilderBasedDeserializer
Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance. -
BuilderBasedDeserializer
-
BuilderBasedDeserializer
-
BuilderBasedDeserializer
-
BuilderBasedDeserializer
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps, Set<String> includableProps) -
BuilderBasedDeserializer
-
-
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
Main deserialization method for bean-based objects (POJOs).- 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 Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.- Overrides:
deserialize
in classJsonDeserializer<Object>
- Throws:
IOException
-
deserializeFromObject
General version used when handling needs more advanced features.- Specified by:
deserializeFromObject
in classBeanDeserializerBase
- Throws:
IOException
-
_deserializeUsingPropertyBased
protected 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
- Returns:
- Builder instance constructed
- Throws:
IOException
-
_deserialize
protected final Object _deserialize(JsonParser p, DeserializationContext ctxt, Object builder) throws IOException - Throws:
IOException
-
_deserializeFromArray
protected Object _deserializeFromArray(JsonParser p, DeserializationContext ctxt) throws IOException Description copied from class:StdDeserializer
Helper method that allows easy support for array-related coercion features: checks for either empty array, or single-value array-wrapped value (if coercion enabled byCoercionConfigs
(since 2.12), and either reports an exception (if no coercion allowed), or returns appropriate result value using coercion mechanism indicated.This method should NOT be called if Array representation is explicitly supported for type: it should only be called in case it is otherwise unrecognized.
NOTE: in case of unwrapped single element, will handle actual decoding by calling
StdDeserializer._deserializeWrappedValue(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonParser, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext)
, which by default callsJsonDeserializer.deserialize(JsonParser, DeserializationContext)
.- Overrides:
_deserializeFromArray
in classStdDeserializer<Object>
- Throws:
IOException
-
deserializeWithView
protected final Object deserializeWithView(JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView) throws IOException - Throws:
IOException
-
deserializeWithUnwrapped
protected Object deserializeWithUnwrapped(JsonParser p, DeserializationContext ctxt) throws IOException Method called when there are declared "unwrapped" properties which need special handling- Throws:
IOException
-
deserializeUsingPropertyBasedWithUnwrapped
protected Object deserializeUsingPropertyBasedWithUnwrapped(JsonParser p, DeserializationContext ctxt) throws IOException - Throws:
IOException
-
deserializeWithUnwrapped
protected Object deserializeWithUnwrapped(JsonParser p, DeserializationContext ctxt, Object builder, TokenBuffer tokens) throws IOException - Throws:
IOException
-
deserializeWithExternalTypeId
protected Object deserializeWithExternalTypeId(JsonParser p, DeserializationContext ctxt) throws IOException - Throws:
IOException
-
deserializeWithExternalTypeId
protected Object deserializeWithExternalTypeId(JsonParser p, DeserializationContext ctxt, Object bean) throws IOException - Throws:
IOException
-
deserializeUsingPropertyBasedWithExternalTypeId
protected Object deserializeUsingPropertyBasedWithExternalTypeId(JsonParser p, DeserializationContext ctxt) throws IOException - Throws:
IOException
-