| Modifier and Type | Class and Description |
|---|---|
| public static class | |
| protected abstract static class | |
| public static class | DateDeserializers.DateDeserializer
Simple deserializer for handling |
| public static class | DateDeserializers.SqlDateDeserializer
Compared to plain old |
| public static class | DateDeserializers.TimestampDeserializer
Simple deserializer for handling |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static JsonDeserializer | |
| public static boolean |
| _utilClasses | back to summary |
|---|---|
| private static final HashSet<String> _utilClasses | |
| DateDeserializers | back to summary |
|---|---|
| public DateDeserializers() | |
| find | back to summary |
|---|---|
| public static JsonDeserializer | |
| hasDeserializerFor | back to summary |
|---|---|
| public static boolean hasDeserializerFor(Class<?> rawType) | |
| Modifier and Type | Field and Description |
|---|---|
| protected final Constructor | _defaultCtor
We may know actual expected type; if so, it will be used for instantiation. |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | CalendarDeserializer(DateDeserializers.
|
| Modifier and Type | Method and Description |
|---|---|
| public Calendar | deserialize(JsonParser
Parsed used for reading JSON content p, DeserializationContext Context that can be used to access information about
this deserialization activity. ctxt)Implements abstract com. |
| public Object | getEmptyValue(DeserializationContext ctxt)
Overrides com. |
| protected DateDeserializers. | withDateFormat(DateFormat df, String formatString)
Implements abstract com. |
| _defaultCtor | back to summary |
|---|---|
| protected final Constructor<Calendar> _defaultCtor We may know actual expected type; if so, it will be used for instantiation.
| |
| CalendarDeserializer | back to summary |
|---|---|
| public CalendarDeserializer() | |
| CalendarDeserializer | back to summary |
|---|---|
public CalendarDeserializer(Class<? extends Calendar> cc)
| |
| CalendarDeserializer | back to summary |
|---|---|
| public CalendarDeserializer(DateDeserializers. | |
| deserialize | back to summary |
|---|---|
| public Calendar deserialize(JsonParser p, DeserializationContext ctxt) throws IOException Implements abstract com. Doc from com. 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.
| |
| getEmptyValue | back to summary |
|---|---|
| public Object getEmptyValue(DeserializationContext ctxt) Overrides com. Doc from com. Method called to determine value to be used for "empty" values
(most commonly when deserializing from empty JSON Strings).
Usually this is same as
This method may be called once, or multiple times, depending on what
Default implementation simply calls
| |
| withDateFormat | back to summary |
|---|---|
| protected DateDeserializers. Implements abstract com.
| |
| Modifier and Type | Field and Description |
|---|---|
| protected final DateFormat | _customFormat
Specific format to use, if non-null; if null will just use default format. |
| protected final String | _formatString
Let's also keep format String for reference, to use for error messages |
| Access | Constructor and Description |
|---|---|
| protected | |
| protected | DateBasedDeserializer(DateDeserializers.
|
| Modifier and Type | Method and Description |
|---|---|
| protected Date | |
| public JsonDeserializer | createContextual(DeserializationContext
Deserialization context to access configuration, additional
deserializers that may be needed by this deserializer ctxt, BeanProperty 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) property)Implements com. |
| public LogicalType | logicalType()
Overrides com. |
| protected abstract DateDeserializers. |
| _customFormat | back to summary |
|---|---|
| protected final DateFormat _customFormat Specific format to use, if non-null; if null will just use default format. | |
| _formatString | back to summary |
|---|---|
| protected final String _formatString Let's also keep format String for reference, to use for error messages | |
| DateBasedDeserializer | back to summary |
|---|---|
| protected DateBasedDeserializer(Class<?> clz) | |
| DateBasedDeserializer | back to summary |
|---|---|
| protected DateBasedDeserializer(DateDeserializers. | |
| _parseDate | back to summary |
|---|---|
| protected Date _parseDate(JsonParser p, DeserializationContext ctxt) throws IOException Overrides com.
| |
| createContextual | back to summary |
|---|---|
| public JsonDeserializer Implements com. Doc from com. 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.
| |
| logicalType | back to summary |
|---|---|
| public LogicalType logicalType() Overrides com. Doc from com. 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.
| |
| withDateFormat | back to summary |
|---|---|
| protected abstract DateDeserializers. | |
java.util.Date values.
One way to customize Date formats accepted is to override method
DeserializationContext#parseDate that this basic
deserializer calls.
| Modifier and Type | Field and Description |
|---|---|
| public static final DateDeserializers. |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Date | deserialize(JsonParser
Parsed used for reading JSON content p, DeserializationContext Context that can be used to access information about
this deserialization activity. ctxt)Implements abstract com. |
| public Object | getEmptyValue(DeserializationContext ctxt)
Overrides com. |
| protected DateDeserializers. | withDateFormat(DateFormat df, String formatString)
Implements abstract com. |
| instance | back to summary |
|---|---|
| public static final DateDeserializers. | |
| DateDeserializer | back to summary |
|---|---|
| public DateDeserializer() | |
| DateDeserializer | back to summary |
|---|---|
| public DateDeserializer(DateDeserializers. | |
| deserialize | back to summary |
|---|---|
| public Date deserialize(JsonParser p, DeserializationContext ctxt) throws IOException Implements abstract com. Doc from com. 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.
| |
| getEmptyValue | back to summary |
|---|---|
| public Object getEmptyValue(DeserializationContext ctxt) Overrides com. Doc from com. Method called to determine value to be used for "empty" values
(most commonly when deserializing from empty JSON Strings).
Usually this is same as
This method may be called once, or multiple times, depending on what
Default implementation simply calls
| |
| withDateFormat | back to summary |
|---|---|
| protected DateDeserializers. Implements abstract com.
| |
java.util.Date , SQL version is easier
to deal with: mostly because it is more limited.
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Date | deserialize(JsonParser
Parsed used for reading JSON content p, DeserializationContext Context that can be used to access information about
this deserialization activity. ctxt)Implements abstract com. |
| public Object | getEmptyValue(DeserializationContext ctxt)
Overrides com. |
| protected DateDeserializers. | withDateFormat(DateFormat df, String formatString)
Implements abstract com. |
| SqlDateDeserializer | back to summary |
|---|---|
| public SqlDateDeserializer() | |
| SqlDateDeserializer | back to summary |
|---|---|
| public SqlDateDeserializer(DateDeserializers. | |
| deserialize | back to summary |
|---|---|
| public Date deserialize(JsonParser p, DeserializationContext ctxt) throws IOException Implements abstract com. Doc from com. 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.
| |
| getEmptyValue | back to summary |
|---|---|
| public Object getEmptyValue(DeserializationContext ctxt) Overrides com. Doc from com. Method called to determine value to be used for "empty" values
(most commonly when deserializing from empty JSON Strings).
Usually this is same as
This method may be called once, or multiple times, depending on what
Default implementation simply calls
| |
| withDateFormat | back to summary |
|---|---|
| protected DateDeserializers. Implements abstract com.
| |
java.sql.Timestamp values.
One way to customize Timestamp formats accepted is to override method
DeserializationContext#parseDate that this basic
deserializer calls.
| Access | Constructor and Description |
|---|---|
| public | |
| public | TimestampDeserializer(DateDeserializers.
|
| Modifier and Type | Method and Description |
|---|---|
| public Timestamp | deserialize(JsonParser
Parsed used for reading JSON content p, DeserializationContext Context that can be used to access information about
this deserialization activity. ctxt)Implements abstract com. |
| public Object | getEmptyValue(DeserializationContext ctxt)
Overrides com. |
| protected DateDeserializers. | withDateFormat(DateFormat df, String formatString)
Implements abstract com. |
| TimestampDeserializer | back to summary |
|---|---|
| public TimestampDeserializer() | |
| TimestampDeserializer | back to summary |
|---|---|
| public TimestampDeserializer(DateDeserializers. | |
| deserialize | back to summary |
|---|---|
| public Timestamp deserialize(JsonParser p, DeserializationContext ctxt) throws IOException Implements abstract com. Doc from com. 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.
| |
| getEmptyValue | back to summary |
|---|---|
| public Object getEmptyValue(DeserializationContext ctxt) Overrides com. Doc from com. Method called to determine value to be used for "empty" values
(most commonly when deserializing from empty JSON Strings).
Usually this is same as
This method may be called once, or multiple times, depending on what
Default implementation simply calls
| |
| withDateFormat | back to summary |
|---|---|
| protected DateDeserializers. Implements abstract com.
| |