Class BeanAsArrayBuilderDeserializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonDeserializer<T>
-
- com.fasterxml.jackson.databind.deser.std.StdDeserializer<java.lang.Object>
-
- com.fasterxml.jackson.databind.deser.BeanDeserializerBase
-
- com.fasterxml.jackson.databind.deser.impl.BeanAsArrayBuilderDeserializer
-
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ResolvableDeserializer
,ValueInstantiator.Gettable
,java.io.Serializable
public class BeanAsArrayBuilderDeserializer extends BeanDeserializerBase
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
-
Constructor Summary
Constructors Constructor Description 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 Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
deserialize(JsonParser p, DeserializationContext ctxt)
Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.java.lang.Object
deserialize(JsonParser p, DeserializationContext ctxt, java.lang.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.java.lang.Object
deserializeFromObject(JsonParser p, DeserializationContext ctxt)
General version used when handling needs more advanced features.java.lang.Boolean
supportsUpdate(DeserializationConfig config)
Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.JsonDeserializer<java.lang.Object>
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.BeanDeserializerBase
withBeanProperties(BeanPropertyMap props)
Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.BeanDeserializerBase
withByNameInclusion(java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
BeanDeserializerBase
withIgnoreAllUnknown(boolean ignoreUnknown)
BeanDeserializerBase
withObjectIdReader(ObjectIdReader oir)
-
Methods inherited from class com.fasterxml.jackson.databind.deser.BeanDeserializerBase
createContextual, creatorProperties, deserializeFromArray, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromString, deserializeWithType, findBackReference, findProperty, findProperty, findProperty, getBeanClass, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, hasProperty, hasViews, isCachable, isCaseInsensitive, logicalType, properties, replaceProperty, resolve, withIgnorableProperties, wrapAndThrow
-
Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
getValueClass, getValueType
-
Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, getAbsentValue, getDelegatee, getEmptyValue, getNullValue, getNullValue, replaceDelegatee
-
-
-
-
Constructor Detail
-
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 Detail
-
unwrappingDeserializer
public JsonDeserializer<java.lang.Object> unwrappingDeserializer(NameTransformer unwrapper)
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
public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)
- Specified by:
withObjectIdReader
in classBeanDeserializerBase
-
withByNameInclusion
public BeanDeserializerBase withByNameInclusion(java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
- Specified by:
withByNameInclusion
in classBeanDeserializerBase
-
withIgnoreAllUnknown
public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown)
- Specified by:
withIgnoreAllUnknown
in classBeanDeserializerBase
-
withBeanProperties
public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)
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
-
supportsUpdate
public java.lang.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 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 deserialization 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
-
deserialize
public java.lang.Object deserialize(JsonParser p, DeserializationContext ctxt) throws java.io.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 classJsonDeserializer<java.lang.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:
java.io.IOException
-
deserialize
public java.lang.Object deserialize(JsonParser p, DeserializationContext ctxt, java.lang.Object value) throws java.io.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<java.lang.Object>
- Throws:
java.io.IOException
-
deserializeFromObject
public java.lang.Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws java.io.IOException
Description copied from class:BeanDeserializerBase
General version used when handling needs more advanced features.- Specified by:
deserializeFromObject
in classBeanDeserializerBase
- Throws:
java.io.IOException
-
-