Top Description Fields Constructors Methods
com.fasterxml.jackson.dataformat.xml.deser

public Class WrapperHandlingDeserializer

extends DelegatingDeserializer
Class Inheritance
Imports
java.io.IOException, java.util.*, com.fasterxml.jackson.core.JsonParser, .JsonToken, com.fasterxml.jackson.core.util.JsonParserDelegate, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.deser.*, com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.dataformat.xml.util.TypeUtil

Delegating deserializer whose only function is to handle case of "unwrapped" List/array deserialization from XML.

Field Summary

Modifier and TypeField and Description
protected final boolean
protected final Set<String>
_namesToWrap

(Simple) Names of properties, for which virtual wrapping is needed to compensate: these are so-called 'unwrapped' XML lists where property name is used for elements, and not as List markers.

protected final JavaType
private static final long
Inherited from com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer:
_delegatee

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
protected final void
protected BeanDeserializerBase
public JsonDeserializer<?>
createContextual(DeserializationContext
Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
ctxt
,
BeanProperty
Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)
property
)

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.createContextual.

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
public Object
deserialize(JsonParser
Parsed used for reading JSON content
p
,
DeserializationContext
Context that can be used to access information about this deserialization activity.
ctxt
)

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

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 intoValue)

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.
public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information
typeDeserializer
)

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.
protected JsonDeserializer<?>
Inherited from com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer:
findBackReferencegetAbsentValuegetDelegateegetEmptyAccessPatterngetEmptyValuegetKnownPropertyNamesgetNullAccessPatterngetNullValuegetObjectIdReaderisCachablelogicalTypereplaceDelegateeresolvesupportsUpdateunwrappingDeserializer

Field Detail

_caseInsensitiveback to summary
protected final boolean _caseInsensitive
_namesToWrapback to summary
protected final Set<String> _namesToWrap

(Simple) Names of properties, for which virtual wrapping is needed to compensate: these are so-called 'unwrapped' XML lists where property name is used for elements, and not as List markers.

_typeback to summary
protected final JavaType _type
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.serialVersionUID.

Constructor Detail

WrapperHandlingDeserializerback to summary
public WrapperHandlingDeserializer(BeanDeserializerBase delegate)
WrapperHandlingDeserializerback to summary
public WrapperHandlingDeserializer(BeanDeserializerBase delegate, Set<String> namesToWrap)

Method Detail

_configureParserback to summary
protected final void _configureParser(JsonParser p) throws IOException
Annotations
@SuppressWarnings:resource
_verifyDeserTypeback to summary
protected BeanDeserializerBase _verifyDeserType(JsonDeserializer<?> deser)
createContextualback to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.createContextual.

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Parameters
ctxt:DeserializationContext

Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property:BeanProperty

Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)

Returns:JsonDeserializer<?>

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations
@Override
deserializeback to summary
public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

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.

Parameters
p:JsonParser

Parsed used for reading JSON content

ctxt:DeserializationContext

Context that can be used to access information about this deserialization activity.

Returns:Object

Deserialized value

Annotations
@Override
deserializeback to summary
public Object deserialize(JsonParser p, DeserializationContext ctxt, Object intoValue) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, 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)

Annotations
@SuppressWarnings:unchecked
@Override
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.deserializeWithType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Parameters
typeDeserializer:TypeDeserializer

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType.

Deserializer to use for handling type information

Annotations
@Override
newDelegatingInstanceback to summary
protected JsonDeserializer<?> newDelegatingInstance(JsonDeserializer<?> newDelegatee0)

Implements abstract com.fasterxml.jackson.databind.deser.std.DelegatingDeserializer.newDelegatingInstance.

Annotations
@Override