Top Fields Constructors Methods
com.fasterxml.jackson.databind.deser.std

public Class ByteBufferDeserializer

extends StdScalarDeserializer<ByteBuffer>
Class Inheritance
Imports
java.io.*, java.nio.ByteBuffer, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.type.LogicalType, com.fasterxml.jackson.databind.util.ByteBufferBackedOutputStream

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

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

Constructor Summary

AccessConstructor and Description
protected
ByteBufferDeserializer()

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer
deserialize(JsonParser
Parser used for reading JSON content
parser, DeserializationContext
Context that can be used to access information about this deserialization activity.
cx)

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.

public ByteBuffer
deserialize(JsonParser jp, DeserializationContext ctxt, ByteBuffer intoValue)

Overrides com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer.deserialize.

Overridden to simply call deserialize() method that does not take value to update, since scalar values are usually non-mergeable.

public LogicalType
logicalType()

Overrides com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

Inherited from com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer:
deserializeWithTypegetEmptyAccessPatterngetNullAccessPatternsupportsUpdate

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

ByteBufferDeserializerback to summary
protected ByteBufferDeserializer()

Method Detail

deserializeback to summary
public ByteBuffer deserialize(JsonParser parser, DeserializationContext cx) 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
parser:JsonParser

Parser used for reading JSON content

cx:DeserializationContext

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

Returns:ByteBuffer

Deserialized value

Annotations
@Override
deserializeback to summary
public ByteBuffer deserialize(JsonParser jp, DeserializationContext ctxt, ByteBuffer intoValue) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer.deserialize.

Overridden to simply call deserialize() method that does not take value to update, since scalar values are usually non-mergeable.

Annotations
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer.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