Top Fields Constructors Methods
tools.jackson.datatype.jodamoney

public Class MoneyDeserializer

extends StdDeserializer<Money>
Class Inheritance
Imports
java.math.BigDecimal, java.util.Arrays, .Collection, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, tools.jackson.databind.DeserializationContext, tools.jackson.databind.deser.std.StdDeserializer, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType, org.joda.money.CurrencyUnit, .Money

Field Summary

Modifier and TypeField and Description
private final AmountConverter
amountConverter

private final String
F_AMOUNT

private final String
F_CURRENCY

Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
public
MoneyDeserializer()

pack-priv
MoneyDeserializer(final AmountConverter amountConverter)

Method Summary

Modifier and TypeMethod and Description
public Money
deserialize(final JsonParser p, final 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 Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public Collection<Object>
getKnownPropertyNames()

Overrides tools.jackson.databind.ValueDeserializer.getKnownPropertyNames.

Method that will either return null to indicate that type being deserializers has no concept of properties; or a collection of identifiers for which toString will give external property name.

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_byteOverflow_checkBooleanToStringCoercion_checkCoercionFail_checkDoubleSpecialValue_checkFloatSpecialValue_checkFloatToIntCoercion_checkFloatToStringCoercion_checkFromStringCoercion_checkFromStringCoercion_checkIntToFloatCoercion_checkIntToStringCoercion_checkTextualNull_checkToStringCoercion_coerceBooleanFromInt_coercedTypeDesc_coercedTypeDesc_coerceIntegral_deserializeFromArray_deserializeFromEmptyString_deserializeFromString_deserializeWrappedValue_findCoercionFromBlankString_findCoercionFromEmptyArray_findCoercionFromEmptyString_findNullProvider_hasTextualNull_intOverflow_isBlank_isFalse_isIntNumber_isNaN_isNegInf_isPosInf_isTrue_neitherNull_nonNullNumber_parseBoolean_parseBooleanPrimitive_parseBytePrimitive_parseDate_parseDate_parseDateFromArray_parseDouble_parseDoublePrimitive_parseDoublePrimitive_parseFloatPrimitive_parseFloatPrimitive_parseInteger_parseInteger_parseIntPrimitive_parseIntPrimitive_parseLong_parseLong_parseLongPrimitive_parseLongPrimitive_parseShortPrimitive_parseString_reportFailedNullCoerce_shortOverflow_verifyEndArrayForSingle_verifyNullForPrimitive_verifyNullForPrimitiveCoercion_wrapIOFailurefindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueInstantiatorgetValueTypegetValueTypehandledTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Field Detail

amountConverterback to summary
private final AmountConverter amountConverter
F_AMOUNTback to summary
private final String F_AMOUNT
F_CURRENCYback to summary
private final String F_CURRENCY

Constructor Detail

MoneyDeserializerback to summary
public MoneyDeserializer()
Annotations
@SuppressWarnings:unused
MoneyDeserializerback to summary
pack-priv MoneyDeserializer(final AmountConverter amountConverter)

Method Detail

deserializeback to summary
public Money deserialize(final JsonParser p, final 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
@Override
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from tools.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.

Annotations
@Override
getKnownPropertyNamesback to summary
public Collection<Object> getKnownPropertyNames()

Overrides tools.jackson.databind.ValueDeserializer.getKnownPropertyNames.

Doc from tools.jackson.databind.ValueDeserializer.getKnownPropertyNames.

Method that will either return null to indicate that type being deserializers has no concept of properties; or a collection of identifiers for which toString will give external property name. This is only to be used for error reporting and diagnostics purposes (most commonly, to accompany "unknown property" exception).

Annotations
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides tools.jackson.databind.ValueDeserializer.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