Top Description Fields Constructors Methods
com.fasterxml.jackson.datatype.guava.deser

public Class RangeDeserializer

extends StdDeserializer<Range<?>>
implements ContextualDeserializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.deser.ContextualDeserializer
Imports
java.io.IOException, java.util.Arrays, java.util.regex.Pattern, com.fasterxml.jackson.annotation.JsonFormat, com.google.common.base.Preconditions, com.google.common.collect.BoundType, .Range, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.deser.ContextualDeserializer, com.fasterxml.jackson.databind.deser.std.StdDeserializer, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.databind.type.LogicalType, .TypeFactory, com.fasterxml.jackson.databind.util.ClassUtil, com.fasterxml.jackson.datatype.guava.deser.util.RangeFactory, .RangeHelper

Jackson deserializer for a Guava Range.

Todo

I think it would make sense to reimplement this deserializer to use Delegating Deserializer, using a POJO as an intermediate form (properties could be of type java.lang.Object) This would also also simplify the implementation a bit.

Field Summary

Modifier and TypeField and Description
protected final BoundType
protected final JsonDeserializer<Object>
_endpointDeserializer

Deserializer used when getting JSON Object representation

protected final RangeHelper.RangeProperties
protected final KeyDeserializer
_fromStringDeserializer

Deserializer used when getting JSON String (inline) representation.

protected final JavaType
protected final JsonFormat.Shape
protected static final Pattern
private static final long
Inherited from com.fasterxml.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_ACCEPT_ARRAYSF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
public
RangeDeserializer(BoundType defaultBoundType, JavaType rangeType)

public
RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser)
Deprecated

public
RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType)
Deprecated

protected
RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType, RangeHelper.RangeProperties fieldNames)
Deprecated Since 2.17 use other constructor(s)

protected
RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType, RangeHelper.RangeProperties fieldNames, JsonFormat.Shape shape, KeyDeserializer fromStringDeserializer)

Method Summary

Modifier and TypeMethod and Description
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.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

public Range<?>
deserialize(JsonParser
Parser used for reading JSON content
p
,
DeserializationContext
Context that can be used to access information about this deserialization activity.
context
)

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

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

private BoundType
private Comparable<?>
private Range<?>
private Comparable<?>
public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information
typeDeserializer
)

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

private void
expect(DeserializationContext context, JsonToken expected, JsonToken actual)

public JavaType
getValueType()

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.getValueType.

Exact structured type this deserializer handles, if known.

private boolean
public LogicalType
logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from com.fasterxml.jackson.databind.deser.std.StdDeserializer:
_byteOverflow_checkBooleanToStringCoercion_checkCoercionFail_checkDoubleSpecialValue_checkFloatSpecialValue_checkFloatToIntCoercion_checkFloatToStringCoercion_checkFromStringCoercion_checkFromStringCoercion_checkIntToFloatCoercion_checkIntToStringCoercion_checkTextualNull_checkToStringCoercion_coerceBooleanFromInt_coercedTypeDesc_coercedTypeDesc_coerceEmptyString_coerceIntegral_coerceNullToken_coerceTextualNull_deserializeFromArray_deserializeFromEmpty_deserializeFromEmptyString_deserializeFromString_deserializeWrappedValue_failDoubleToIntCoercion_findCoercionFromBlankString_findCoercionFromEmptyArray_findCoercionFromEmptyString_findNullProvider_hasTextualNull_intOverflow_isBlank_isEmptyOrTextualNull_isFalse_isIntNumber_isNaN_isNegInf_isPosInf_isTrue_neitherNull_nonNullNumber_parseBoolean_parseBooleanFromInt_parseBooleanPrimitive_parseBooleanPrimitive_parseBytePrimitive_parseDate_parseDate_parseDateFromArray_parseDouble_parseDouble_parseDoublePrimitive_parseDoublePrimitive_parseDoublePrimitive_parseFloatPrimitive_parseFloatPrimitive_parseFloatPrimitive_parseInteger_parseInteger_parseIntPrimitive_parseIntPrimitive_parseLong_parseLong_parseLongPrimitive_parseLongPrimitive_parseShortPrimitive_parseString_parseString_reportFailedNullCoerce_shortOverflow_verifyEndArrayForSingle_verifyNullForPrimitive_verifyNullForPrimitiveCoercion_verifyNullForScalarCoercion_verifyNumberForScalarCoercion_verifyStringForScalarCoercionfindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueClassgetValueInstantiatorgetValueTypehandledTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Field Detail

_defaultBoundTypeback to summary
protected final BoundType _defaultBoundType
_endpointDeserializerback to summary
protected final JsonDeserializer<Object> _endpointDeserializer

Deserializer used when getting JSON Object representation

_fieldNamesback to summary
protected final RangeHelper.RangeProperties _fieldNames
Since
2.10
_fromStringDeserializerback to summary
protected final KeyDeserializer _fromStringDeserializer

Deserializer used when getting JSON String (inline) representation.

Since
2.17
_rangeTypeback to summary
protected final JavaType _rangeType
_shapeback to summary
protected final JsonFormat.Shape _shape
Since
2.17
PATTERN_DOUBLE_DOTback to summary
protected static final Pattern PATTERN_DOUBLE_DOT
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.StdDeserializer.serialVersionUID.

Constructor Detail

RangeDeserializerback to summary
public RangeDeserializer(BoundType defaultBoundType, JavaType rangeType)
RangeDeserializerback to summary
public RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser)

Deprecated

Annotations
@Deprecated
RangeDeserializerback to summary
public RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType)

Deprecated

Annotations
@Deprecated
RangeDeserializerback to summary
protected RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType, RangeHelper.RangeProperties fieldNames)

Deprecated

Since 2.17 use other constructor(s)

Annotations
@Deprecated
Since
2.10
RangeDeserializerback to summary
protected RangeDeserializer(JavaType rangeType, JsonDeserializer<?> endpointDeser, BoundType defaultBoundType, RangeHelper.RangeProperties fieldNames, JsonFormat.Shape shape, KeyDeserializer fromStringDeserializer)
Annotations
@SuppressWarnings:unchecked
Since
2.17

Method Detail

createContextualback to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

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.

Parameters
ctxt:DeserializationContext

Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property: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)

Returns:JsonDeserializer<?>

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations
@Override
deserializeback to summary
public Range<?> deserialize(JsonParser p, DeserializationContext context) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 JsonDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer#getNullValue(DeserializationContext) and usually also JsonDeserializer#getNullAccessPattern().

Parameters
p:JsonParser

Parser used for reading JSON content

context:DeserializationContext

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

Returns:Range<?>

Deserialized value

Annotations
@Override
deserializeBoundTypeback to summary
private BoundType deserializeBoundType(DeserializationContext context, JsonParser p) throws IOException
deserializeEndpointback to summary
private Comparable<?> deserializeEndpoint(DeserializationContext context, JsonParser p) throws IOException
deserializeRangeFromStringback to summary
private Range<?> deserializeRangeFromString(DeserializationContext context, JsonParser p) throws IOException
deserializeStringifiedback to summary
private Comparable<?> deserializeStringified(DeserializationContext context, String value) throws IOException
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Parameters
typeDeserializer:TypeDeserializer

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType.

Deserializer to use for handling type information

Annotations
@Override
expectback to summary
private void expect(DeserializationContext context, JsonToken expected, JsonToken actual) throws JsonMappingException
getValueTypeback to summary
public JavaType getValueType()

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.getValueType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.getValueType.

Exact structured type this deserializer handles, if known.

Annotations
@Override
isValidBracketNotationback to summary
private boolean isValidBracketNotation(String range)
logicalTypeback to summary
public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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.

Returns:LogicalType

Logical type of values this deserializer produces, if known; null if not

Annotations
@Override