Top Description Fields Constructors Methods
tools.jackson.datatype.guava.deser.table

public Class ImmutableTableDeserializer

extends TableDeserializer<ImmutableTable<Object, Object, Object>>
Class Inheritance
Imports
tools.jackson.core.JsonParser, .JsonToken, tools.jackson.databind.DeserializationContext, .ValueDeserializer, .KeyDeserializer, tools.jackson.databind.deser.NullValueProvider, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.MapLikeType, tools.jackson.databind.util.AccessPattern, com.google.common.collect.ImmutableMap, .ImmutableTable

Provides deserialization for the Guava ImmutableTable class.
Author
Abhishekkr3003

Field Summary

Inherited from tools.jackson.datatype.guava.deser.table.TableDeserializer:
_colDeserializer_nullProvider_rowDeserializer_skipNullValues_type_valueDeserializer_valueTypeDeserializer

Constructor Summary

AccessConstructor and Description
public
protected
ImmutableTableDeserializer(MapLikeType type, KeyDeserializer rowDeserializer, KeyDeserializer colDeserializer, ValueDeserializer<?> valueDeserializer, TypeDeserializer valueTypeDeserializer, NullValueProvider nuller)

Method Summary

Modifier and TypeMethod and Description
protected ValueDeserializer<?>
_createContextual(MapLikeType type, KeyDeserializer rowDeserializer, KeyDeserializer columnDeserializer, TypeDeserializer valueTypeDeserializer, ValueDeserializer<?> valueDeserializer, NullValueProvider nullValueProvider)

Implements abstract tools.jackson.datatype.guava.deser.table.TableDeserializer._createContextual.

protected ImmutableTable.Builder<Object, Object, Object>
public ImmutableTable<Object, Object, Object>
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 AccessPattern
getEmptyAccessPattern()

Overrides tools.jackson.databind.ValueDeserializer.getEmptyAccessPattern.

This method may be called in conjunction with calls to getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

public Object
getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).

Inherited from tools.jackson.datatype.guava.deser.table.TableDeserializer:
createContextualexpect

Constructor Detail

ImmutableTableDeserializerback to summary
public ImmutableTableDeserializer(MapLikeType type)
ImmutableTableDeserializerback to summary
protected ImmutableTableDeserializer(MapLikeType type, KeyDeserializer rowDeserializer, KeyDeserializer colDeserializer, ValueDeserializer<?> valueDeserializer, TypeDeserializer valueTypeDeserializer, NullValueProvider nuller)

Method Detail

_createContextualback to summary
protected ValueDeserializer<?> _createContextual(MapLikeType type, KeyDeserializer rowDeserializer, KeyDeserializer columnDeserializer, TypeDeserializer valueTypeDeserializer, ValueDeserializer<?> valueDeserializer, NullValueProvider nullValueProvider)

Implements abstract tools.jackson.datatype.guava.deser.table.TableDeserializer._createContextual.

Annotations
@Override
createBuilderback to summary
protected ImmutableTable.Builder<Object, Object, Object> createBuilder()
deserializeback to summary
public ImmutableTable<Object, Object, Object> deserialize(JsonParser p, DeserializationContext ctxt)

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
getEmptyAccessPatternback to summary
public AccessPattern getEmptyAccessPattern()

Overrides tools.jackson.databind.ValueDeserializer.getEmptyAccessPattern.

Doc from tools.jackson.databind.ValueDeserializer.getEmptyAccessPattern.

This method may be called in conjunction with calls to getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

Annotations
@Override
getEmptyValueback to summary
public Object getEmptyValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.getEmptyValue.

Doc from tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as getNullValue (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 getEmptyAccessPattern() returns.

Default implementation simply calls getNullValue and returns value.

Annotations
@Override