Class ExternalTypeHandler
- java.lang.Object
-
- com.fasterxml.jackson.databind.deser.impl.ExternalTypeHandler
-
public class ExternalTypeHandler extends java.lang.Object
Helper class that is used to flatten JSON structure when using "external type id" (seeJsonTypeInfo.As.EXTERNAL_PROPERTY
). This is needed to store temporary state and buffer tokens, as the structure is rearranged a bit so that actual type deserializer can resolve type and finalize deserialization.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExternalTypeHandler.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExternalTypeHandler.Builder
builder(JavaType beanType)
java.lang.Object
complete(JsonParser p, DeserializationContext ctxt, PropertyValueBuffer buffer, PropertyBasedCreator creator)
Variant called when creation of the POJO involves buffering of creator properties as well as property-based creator.java.lang.Object
complete(JsonParser p, DeserializationContext ctxt, java.lang.Object bean)
Method called after JSON Object closes, and has to ensure that all external type ids have been handled.boolean
handlePropertyValue(JsonParser p, DeserializationContext ctxt, java.lang.String propName, java.lang.Object bean)
Method called to ask handler to handle value of given property, at point where parser points to the first token of the value.boolean
handleTypePropertyValue(JsonParser p, DeserializationContext ctxt, java.lang.String propName, java.lang.Object bean)
Method called to see if given property/value pair is an external type id; and if so handle it.ExternalTypeHandler
start()
Method called to start collection process by creating non-blueprint instances.
-
-
-
Method Detail
-
builder
public static ExternalTypeHandler.Builder builder(JavaType beanType)
- Since:
- 2.9
-
start
public ExternalTypeHandler start()
Method called to start collection process by creating non-blueprint instances.
-
handleTypePropertyValue
public boolean handleTypePropertyValue(JsonParser p, DeserializationContext ctxt, java.lang.String propName, java.lang.Object bean) throws java.io.IOException
Method called to see if given property/value pair is an external type id; and if so handle it. This is only to be called in case containing POJO has similarly named property as the external type id AND value is of scalar type: otherwisehandlePropertyValue(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, java.lang.String, java.lang.Object)
should be called instead.- Throws:
java.io.IOException
-
handlePropertyValue
public boolean handlePropertyValue(JsonParser p, DeserializationContext ctxt, java.lang.String propName, java.lang.Object bean) throws java.io.IOException
Method called to ask handler to handle value of given property, at point where parser points to the first token of the value. Handling can mean either resolving type id it contains (if it matches type property name), or by buffering the value for further use.- Returns:
- True, if the given property was properly handled
- Throws:
java.io.IOException
-
complete
public java.lang.Object complete(JsonParser p, DeserializationContext ctxt, java.lang.Object bean) throws java.io.IOException
Method called after JSON Object closes, and has to ensure that all external type ids have been handled.- Throws:
java.io.IOException
-
complete
public java.lang.Object complete(JsonParser p, DeserializationContext ctxt, PropertyValueBuffer buffer, PropertyBasedCreator creator) throws java.io.IOException
Variant called when creation of the POJO involves buffering of creator properties as well as property-based creator.- Throws:
java.io.IOException
-
-