Top Description Fields Constructors Methods
tools.jackson.dataformat.xml.deser

public Class XmlTextDeserializer

extends DelegatingDeserializer
Class Inheritance
Imports
tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.deser.*, tools.jackson.databind.deser.bean.BeanDeserializerBase, tools.jackson.databind.deser.std.DelegatingDeserializer, tools.jackson.databind.jsontype.TypeDeserializer

Delegating deserializer that is used in the special cases where we may sometimes see a "plain" String value but need to map it as if it was a property of POJO. The impedance is introduced by heuristic conversion from XML events into rough JSON equivalents; and this is one work-around that can only be done after the fact.

Field Summary

Modifier and TypeField and Description
protected final ValueInstantiator
protected final SettableBeanProperty
_xmlTextProperty

Actual property that is indicated to be of type "XML Text" (and is the only element-valued property)

protected final int
_xmlTextPropertyIndex

Property index of the "XML text property"; needed for finding actual property instance after resolution and contextualization: instance may change, but index will remain constant.

Inherited from tools.jackson.databind.deser.std.DelegatingDeserializer:
_delegatee

Constructor Summary

AccessConstructor and Description
public
public
XmlTextDeserializer(BeanDeserializerBase delegate, int textPropIndex)

Method Summary

Modifier and TypeMethod and Description
protected BeanDeserializerBase
public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

public Object
deserialize(JsonParser p, DeserializationContext ctxt)

Overrides tools.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 bean)

Overrides tools.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 typeDeserializer)

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

protected ValueDeserializer<?>
Inherited from tools.jackson.databind.deser.std.DelegatingDeserializer:
findBackReferencegetAbsentValuegetDelegateegetEmptyAccessPatterngetEmptyValuegetKnownPropertyNamesgetNullAccessPatterngetNullValuegetObjectIdReaderisCachablelogicalTypereplaceDelegateeresolvesupportsUpdateunwrappingDeserializer

Field Detail

_valueInstantiatorback to summary
protected final ValueInstantiator _valueInstantiator
_xmlTextPropertyback to summary
protected final SettableBeanProperty _xmlTextProperty

Actual property that is indicated to be of type "XML Text" (and is the only element-valued property)

_xmlTextPropertyIndexback to summary
protected final int _xmlTextPropertyIndex

Property index of the "XML text property"; needed for finding actual property instance after resolution and contextualization: instance may change, but index will remain constant.

Constructor Detail

XmlTextDeserializerback to summary
public XmlTextDeserializer(BeanDeserializerBase delegate, SettableBeanProperty prop)
XmlTextDeserializerback to summary
public XmlTextDeserializer(BeanDeserializerBase delegate, int textPropIndex)

Method Detail

_verifyDeserTypeback to summary
protected BeanDeserializerBase _verifyDeserType(ValueDeserializer<?> deser)
createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.createContextual.

Doc from tools.jackson.databind.ValueDeserializer.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.

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

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.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).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the ValueDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer#getNullValue(DeserializationContext) and usually also ValueDeserializer#getNullAccessPattern().

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

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.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 JacksonException

Overrides tools.jackson.databind.deser.std.DelegatingDeserializer.deserializeWithType.

Doc from tools.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.

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

Implements abstract tools.jackson.databind.deser.std.DelegatingDeserializer.newDelegatingInstance.

Annotations
@Override