Package com.fasterxml.jackson.databind.deser.std

Class DateDeserializers.DateDeserializer

java.lang.Object

com.fasterxml.jackson.databind.JsonDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer<T>

com.fasterxml.jackson.databind.deser.std.DateDeserializers.DateDeserializer

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, ValueInstantiator.Gettable, Serializable

Enclosing class:

DateDeserializers

public static class DateDeserializers.DateDeserializer
extends StdScalarDeserializer<T>

Simple deserializer for handling Date values.

One way to customize Date formats accepted is to override method DeserializationContext.parseDate(java.lang.String) that this basic deserializer calls.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

JsonDeserializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static DateDeserializers.DateDeserializer	instance

Constructor Summary

Constructors

Constructor	Description
DateDeserializer()
DateDeserializer(DateDeserializers.DateDeserializer base, DateFormat df, String formatString)

Method Summary

Modifier and Type	Method	Description
Date	deserialize(JsonParser p, DeserializationContext ctxt)	Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Object	getEmptyValue(DeserializationContext ctxt)	Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer

deserialize, deserializeWithType, getEmptyAccessPattern, getNullAccessPattern, supportsUpdate

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

getValueClass, getValueInstantiator, getValueType, getValueType, handledType

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

deserializeWithType, findBackReference, getAbsentValue, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullValue, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static final DateDeserializers.DateDeserializer instance

Constructor Detail

DateDeserializer

public DateDeserializer()

DateDeserializer

public DateDeserializer(DateDeserializers.DateDeserializer base,
                        DateFormat df,
                        String formatString)

Method Detail

getEmptyValue

public Object getEmptyValue(DeserializationContext ctxt)

Description copied from class: JsonDeserializer

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) (which in turn is usually simply Java null), but it can be overridden for specific types. Or, if type should never be converted from empty String, method can also throw an exception.

This method may be called once, or multiple times, depending on what JsonDeserializer.getEmptyAccessPattern() returns.

Default implementation simply calls JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) and returns value.

Overrides:

getEmptyValue in class JsonDeserializer<Date>

deserialize

public Date deserialize(JsonParser p,
                        DeserializationContext ctxt)
                 throws IOException

Description copied from class: JsonDeserializer

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.

Specified by:

deserialize in class JsonDeserializer<Date>

Parameters:

p - Parsed used for reading JSON content

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

Returns:

Deserialized value

Throws:

IOException