public abstract class ReferenceTypeDeserializer<T> extends StdDeserializer<T> implements ContextualDeserializer
ReferenceType
values.
Implements most of functionality, only leaving couple of abstract
methods for sub-classes to implementJsonDeserializer.None
Modifier and Type | Field and Description |
---|---|
protected JavaType |
_fullType
Full type of property (or root value) for which this deserializer
has been constructed and contextualized.
|
protected JsonDeserializer<Object> |
_valueDeserializer |
protected ValueInstantiator |
_valueInstantiator |
protected TypeDeserializer |
_valueTypeDeserializer |
_valueClass, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
Constructor and Description |
---|
ReferenceTypeDeserializer(JavaType fullType,
TypeDeserializer typeDeser,
JsonDeserializer<?> deser)
Deprecated.
|
ReferenceTypeDeserializer(JavaType fullType,
ValueInstantiator vi,
TypeDeserializer typeDeser,
JsonDeserializer<?> deser) |
Modifier and Type | Method and Description |
---|---|
JsonDeserializer<?> |
createContextual(DeserializationContext ctxt,
BeanProperty property)
Method called to see if a different (or differently configured) deserializer
is needed to deserialize values of specified property.
|
T |
deserialize(JsonParser p,
DeserializationContext ctxt)
Method that can be called to ask implementation to deserialize
JSON content into the value type this serializer handles.
|
T |
deserialize(JsonParser p,
DeserializationContext ctxt,
T reference)
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. |
Object |
deserializeWithType(JsonParser p,
DeserializationContext ctxt,
TypeDeserializer typeDeserializer)
Base implementation that does not assume specific type
inclusion mechanism.
|
AccessPattern |
getEmptyAccessPattern()
This method may be called in conjunction with calls to
JsonDeserializer.getEmptyValue(DeserializationContext) , to check whether it needs
to be called just once (static values), or each time empty value is
needed. |
Object |
getEmptyValue(DeserializationContext ctxt)
Method called to determine value to be used for "empty" values
(most commonly when deserializing from empty JSON Strings).
|
AccessPattern |
getNullAccessPattern()
Null value varies dynamically (unlike with scalar types),
so let's indicate this.
|
abstract T |
getNullValue(DeserializationContext ctxt)
Method that can be called to determine value to be used for
representing null values (values deserialized when JSON token
is
JsonToken.VALUE_NULL ). |
abstract Object |
getReferenced(T reference)
Method that may be called to find contents of specified reference,
if any; or `null` if none.
|
JavaType |
getValueType()
Exact structured type this deserializer handles, if known.
|
abstract T |
referenceValue(Object contents) |
Boolean |
supportsUpdate(DeserializationConfig config)
By default we assume that updateability mostly relies on value
deserializer; if it supports updates, typically that's what
matters.
|
abstract T |
updateReference(T reference,
Object contents)
Method called in case of "merging update", in which we should try
update reference instead of creating a new one.
|
protected abstract ReferenceTypeDeserializer<T> |
withResolved(TypeDeserializer typeDeser,
JsonDeserializer<?> valueDeser)
Mutant factory method called when changes are needed; should construct
newly configured instance with new values as indicated.
|
_byteOverflow, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeWrappedValue, _failDoubleToIntCoercion, _findNullProvider, _hasTextualNull, _intOverflow, _isEmptyOrTextualNull, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _neitherNull, _nonNullNumber, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseIntPrimitive, _parseIntPrimitive, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, handledType, handleMissingEndArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble
findBackReference, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer
protected final JavaType _fullType
protected final ValueInstantiator _valueInstantiator
protected final TypeDeserializer _valueTypeDeserializer
protected final JsonDeserializer<Object> _valueDeserializer
public ReferenceTypeDeserializer(JavaType fullType, ValueInstantiator vi, TypeDeserializer typeDeser, JsonDeserializer<?> deser)
@Deprecated public ReferenceTypeDeserializer(JavaType fullType, TypeDeserializer typeDeser, JsonDeserializer<?> deser)
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException
ContextualDeserializer
createContextual
in interface ContextualDeserializer
ctxt
- Deserialization context to access configuration, additional
deserializers that may be needed by this deserializerproperty
- 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)JsonMappingException
public AccessPattern getNullAccessPattern()
getNullAccessPattern
in interface NullValueProvider
getNullAccessPattern
in class JsonDeserializer<T>
public AccessPattern getEmptyAccessPattern()
JsonDeserializer
JsonDeserializer.getEmptyValue(DeserializationContext)
, to check whether it needs
to be called just once (static values), or each time empty value is
needed.getEmptyAccessPattern
in class JsonDeserializer<T>
protected abstract ReferenceTypeDeserializer<T> withResolved(TypeDeserializer typeDeser, JsonDeserializer<?> valueDeser)
NOTE: caller has verified that there are changes, so implementations need NOT check if a new instance is needed.
public abstract T getNullValue(DeserializationContext ctxt)
JsonDeserializer
JsonToken.VALUE_NULL
). Usually this is simply
Java null, but for some types (especially primitives) it may be
necessary to use non-null values.
Since version 2.6 (in which the context argument was added), call is expected to be made each and every time a null token needs to be handled.
Default implementation simply returns null.
getNullValue
in interface NullValueProvider
getNullValue
in class JsonDeserializer<T>
public Object getEmptyValue(DeserializationContext ctxt)
JsonDeserializer
JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext)
(which in turn
is usually simply Java null), but it can be overridden
for types. Or, if type should never be converted from empty
String, method can also throw an exception.
Since version 2.6 (in which the context argument was added), call is expected to be made each and every time an empty value is needed.
Since version 2.9 does not require return of `T` any more.
Default implementation simply calls JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext)
and
returns value.
getEmptyValue
in class JsonDeserializer<T>
public abstract T updateReference(T reference, Object contents)
public abstract Object getReferenced(T reference)
public JavaType getValueType()
StdDeserializer
Default implementation just returns null.
getValueType
in class StdDeserializer<T>
public Boolean supportsUpdate(DeserializationConfig config)
supportsUpdate
in class JsonDeserializer<T>
public T deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
JsonDeserializer
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.getCurrentToken() == 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.
deserialize
in class JsonDeserializer<T>
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about
this deserialization activity.IOException
public T deserialize(JsonParser p, DeserializationContext ctxt, T reference) throws IOException
JsonDeserializer
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)
deserialize
in class JsonDeserializer<T>
IOException
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException
StdDeserializer
deserializeWithType
in class StdDeserializer<T>
typeDeserializer
- Deserializer to use for handling type informationIOException
Copyright © 2008–2017 FasterXML. All rights reserved.