Top Description Constructors Methods
tools.jackson.databind.deser.std

public abstract Class FromStringDeserializer<T>

extends StdScalarDeserializer<T>
Class Inheritance
Known Direct Subclasses
tools.jackson.databind.ext.CoreXMLDeserializers.Std, tools.jackson.databind.ext.DOMDeserializer, tools.jackson.databind.deser.jdk.JDKFromStringDeserializer, tools.jackson.databind.deser.jdk.UUIDDeserializer
Imports
java.net.MalformedURLException, .UnknownHostException, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, tools.jackson.databind.DeserializationContext, .JavaType, tools.jackson.databind.cfg.CoercionAction, .CoercionInputShape, tools.jackson.databind.deser.jdk.UUIDDeserializer, tools.jackson.databind.type.LogicalType, tools.jackson.databind.util.ClassUtil

Base class for building simple scalar value deserializers that accept String values.

Constructor Summary

AccessConstructor and Description
protected
protected

Method Summary

Modifier and TypeMethod and Description
protected abstract T
_deserialize(String value, DeserializationContext ctxt)

Main method from trying to deserialize actual value from non-empty String.

protected T
_deserializeEmbedded(Object ob, DeserializationContext ctxt)

Overridable method to allow coercion from embedded value that is neither null nor directly assignable to target type.

protected Object
protected Object
protected Object
protected boolean
public T
deserialize(JsonParser p, DeserializationContext ctxt)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public LogicalType
logicalType()

Overrides tools.jackson.databind.deser.std.StdScalarDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from tools.jackson.databind.deser.std.StdScalarDeserializer:
deserializedeserializeWithTypegetEmptyAccessPatterngetNullAccessPatternsupportsUpdate

Constructor Detail

FromStringDeserializerback to summary
protected FromStringDeserializer(Class<?> vc)
FromStringDeserializerback to summary
protected FromStringDeserializer(JavaType type)

Method Detail

_deserializeback to summary
protected abstract T _deserialize(String value, DeserializationContext ctxt) throws JacksonException, MalformedURLException, UnknownHostException

Main method from trying to deserialize actual value from non-empty String.

_deserializeEmbeddedback to summary
protected T _deserializeEmbedded(Object ob, DeserializationContext ctxt) throws JacksonException

Overridable method to allow coercion from embedded value that is neither null nor directly assignable to target type. Used, for example, by UUIDDeserializer to coerce from byte[].

_deserializeFromEmptyStringback to summary
protected Object _deserializeFromEmptyString(DeserializationContext ctxt) throws JacksonException
_deserializeFromEmptyStringDefaultback to summary
protected Object _deserializeFromEmptyStringDefault(DeserializationContext ctxt) throws JacksonException
_deserializeFromOtherback to summary
protected Object _deserializeFromOther(JsonParser p, DeserializationContext ctxt, JsonToken t) throws JacksonException
_shouldTrimback to summary
protected boolean _shouldTrim()
deserializeback to summary
public T deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.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
@SuppressWarnings:unchecked
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides tools.jackson.databind.deser.std.StdScalarDeserializer.logicalType.

Doc from tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.

Annotations
@Override