BeanDeserializer used for handling deserialization
of POJOs when serialized as JSON Arrays, instead of JSON Objects.
| Modifier and Type | Field and Description |
|---|---|
| protected final BeanDeserializerBase | _delegate
Deserializer we delegate operations that we cannot handle. |
| protected final SettableBeanProperty[] | _orderedProperties
Properties in order expected to be found in JSON array. |
| Access | Constructor and Description |
|---|---|
| public | BeanAsArrayDeserializer(BeanDeserializerBase delegate, SettableBeanProperty[] ordered)
Main constructor used both for creating new instances (by
|
| Modifier and Type | Method and Description |
|---|---|
| protected Object | |
| protected Object | _deserializeNonVanilla(JsonParser p, DeserializationContext ctxt)
Alternate deserialization method that has to check many more configuration aspects than the "vanilla" processing. |
| protected final Object | _deserializeUsingPropertyBased(final JsonParser p, final DeserializationContext ctxt)
Implements abstract tools. 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 | asArrayDeserializer()
Implements abstract tools. Fluent factory for creating a variant that can handle POJO output as a JSON Array. |
| public Object | deserialize(JsonParser p, DeserializationContext ctxt)
Implements abstract tools. Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. |
| public Object | deserialize(JsonParser p, DeserializationContext ctxt, Object bean)
Overrides tools. Alternate deserialization method (compared to the most commonly
used, |
| public Object | deserializeFromObject(JsonParser p, DeserializationContext ctxt)
Implements abstract tools. General version used when handling needs more advanced features. |
| protected void | initNameMatcher(DeserializationContext ctxt)
Implements abstract tools.
|
| public ValueDeserializer | unwrappingDeserializer(DeserializationContext ctxt, NameTransformer unwrapper)
Implements abstract tools. 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. |
| public BeanDeserializerBase | withBeanProperties(BeanPropertyMap props)
Overrides tools. Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems. |
| public BeanDeserializerBase | withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps)
Implements abstract tools.
|
| public BeanDeserializerBase | withIgnoreAllUnknown(boolean ignoreUnknown)
Implements abstract tools.
|
| public BeanDeserializerBase | withObjectIdReader(ObjectIdReader oir)
Implements abstract tools.
|
| _delegate | back to summary |
|---|---|
| protected final BeanDeserializerBase _delegate Deserializer we delegate operations that we cannot handle. | |
| _orderedProperties | back to summary |
|---|---|
| protected final SettableBeanProperty[] _orderedProperties Properties in order expected to be found in JSON array. | |
| BeanAsArrayDeserializer | back to summary |
|---|---|
| public BeanAsArrayDeserializer(BeanDeserializerBase delegate, SettableBeanProperty[] ordered) Main constructor used both for creating new instances (by
| |
| _deserializeFromNonArray | back to summary |
|---|---|
| protected Object _deserializeFromNonArray(JsonParser p, DeserializationContext ctxt) throws JacksonException | |
| _deserializeNonVanilla | back to summary |
|---|---|
| protected Object _deserializeNonVanilla(JsonParser p, DeserializationContext ctxt) throws JacksonException Alternate deserialization method that has to check many more configuration aspects than the "vanilla" processing. | |
| _deserializeUsingPropertyBased | back to summary |
|---|---|
| protected final Object _deserializeUsingPropertyBased(final JsonParser p, final DeserializationContext ctxt) throws JacksonException Implements abstract tools. 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.
| |
| asArrayDeserializer | back to summary |
|---|---|
| protected BeanDeserializerBase asArrayDeserializer() Implements abstract tools. Doc from tools. 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.
| |
| deserialize | back to summary |
|---|---|
| public Object deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException Implements abstract tools. Doc from tools. 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)
| |
| deserialize | back to summary |
|---|---|
| public Object deserialize(JsonParser p, DeserializationContext ctxt, Object bean) throws JacksonException Overrides tools. Doc from tools. Alternate deserialization method (compared to the most commonly
used,
Default implementation just throws
| |
| deserializeFromObject | back to summary |
|---|---|
| public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws JacksonException Implements abstract tools. Doc from tools. General version used when handling needs more advanced features.
| |
| initNameMatcher | back to summary |
|---|---|
| protected void initNameMatcher(DeserializationContext ctxt) Implements abstract tools.
| |
| unwrappingDeserializer | back to summary |
|---|---|
| public ValueDeserializer Implements abstract tools. Doc from tools. 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
| |
| withBeanProperties | back to summary |
|---|---|
| public BeanDeserializerBase withBeanProperties(BeanPropertyMap props) Overrides tools. Doc from tools. Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.
| |
| withByNameInclusion | back to summary |
|---|---|
| public BeanDeserializerBase withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps) Implements abstract tools.
| |
| withIgnoreAllUnknown | back to summary |
|---|---|
| public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown) Implements abstract tools.
| |
| withObjectIdReader | back to summary |
|---|---|
| public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir) Implements abstract tools.
| |