com.couchbase.client.java.transcoder.subdoc

Class JacksonFragmentTranscoder

java.lang.Object

com.couchbase.client.java.transcoder.subdoc.JacksonFragmentTranscoder

All Implemented Interfaces:

FragmentTranscoder

@InterfaceStability.Experimental
 @InterfaceAudience.Private
public class JacksonFragmentTranscoder
extends Object
implements FragmentTranscoder

A Jackson-based implementation of a FragmentTranscoder.

Care should be taken to not use Jackson specific annotations if you want to be able to easily swap this for another SubdocumentTranscoder implementation at a later time.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
JacksonFragmentTranscoder(com.couchbase.client.deps.com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
<T> T	decode(com.couchbase.client.deps.io.netty.buffer.ByteBuf encoded, Class<? extends T> clazz) Decode content in a ByteBuf without releasing it.
<T> T	decodeWithMessage(com.couchbase.client.deps.io.netty.buffer.ByteBuf encoded, Class<? extends T> clazz, String transcodingErrorMessage) Decode content in a ByteBuf without releasing it.
<T> com.couchbase.client.deps.io.netty.buffer.ByteBuf	encode(T value) Encode a value (usually from a DocumentFragment) to a ByteBuf suitable for use in the sub-document protocol.
<T> com.couchbase.client.deps.io.netty.buffer.ByteBuf	encodeWithMessage(T value, String transcodingErrorMessage) Encode a value (usually from a DocumentFragment) to a ByteBuf suitable for use in the sub-document protocol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JacksonFragmentTranscoder

public JacksonFragmentTranscoder(com.couchbase.client.deps.com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

decode

public <T> T decode(com.couchbase.client.deps.io.netty.buffer.ByteBuf encoded,
                    Class<? extends T> clazz)
             throws TranscodingException

Description copied from interface: FragmentTranscoder

Decode content in a ByteBuf without releasing it. Suitable for populating a DocumentFragment’s content.

Specified by:

decode in interface FragmentTranscoder

Parameters:

encoded - the encoded fragment value (will not be released).

clazz - the target class for decoded value. Using Object.class implies a generic decode, where dictionaries are represented by JsonObject and arrays by JsonArray.

Returns:

a decoded fragment.

Throws:

TranscodingException - if the decoding couldn’t happen.

decodeWithMessage

public <T> T decodeWithMessage(com.couchbase.client.deps.io.netty.buffer.ByteBuf encoded,
                               Class<? extends T> clazz,
                               String transcodingErrorMessage)
                        throws TranscodingException

Description copied from interface: FragmentTranscoder

Decode content in a ByteBuf without releasing it. Suitable for populating a DocumentFragment’s content.

Specified by:

decodeWithMessage in interface FragmentTranscoder

Parameters:

encoded - the encoded fragment value (will not be released).

clazz - the target class for decoded value. Using Object.class implies a generic decode, where dictionaries are represented by JsonObject and arrays by JsonArray.

transcodingErrorMessage - the error message to be used in the thrown TranscodingException if the decoding couldn’t happen.

Returns:

a decoded fragment.

Throws:

TranscodingException - if the decoding couldn’t happen.

encode

public <T> com.couchbase.client.deps.io.netty.buffer.ByteBuf encode(T value)
                                                             throws TranscodingException

Description copied from interface: FragmentTranscoder

Encode a value (usually from a DocumentFragment) to a ByteBuf suitable for use in the sub-document protocol.

Specified by:

encode in interface FragmentTranscoder

Parameters:

value - the value to encode.

Returns:

a ByteBuf representation of the fragment value.

Throws:

TranscodingException - if the encoding couldn’t happen.

encodeWithMessage

public <T> com.couchbase.client.deps.io.netty.buffer.ByteBuf encodeWithMessage(T value,
                                                                               String transcodingErrorMessage)
                                                                        throws TranscodingException

Description copied from interface: FragmentTranscoder

Encode a value (usually from a DocumentFragment) to a ByteBuf suitable for use in the sub-document protocol.

Specified by:

encodeWithMessage in interface FragmentTranscoder

Parameters:

value - the value to encode.

transcodingErrorMessage - the error message to be used in the thrown TranscodingException if the encoding couldn’t happen.

Returns:

a ByteBuf representation of the fragment value.

Throws:

TranscodingException - if the encoding couldn’t happen.