com.couchbase.client.java.transcoder

Class BinaryTranscoder

java.lang.Object

com.couchbase.client.java.transcoder.AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

com.couchbase.client.java.transcoder.BinaryTranscoder

All Implemented Interfaces:

Transcoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

public class BinaryTranscoder
extends AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Constructor Summary

Constructors

Constructor and Description
BinaryTranscoder()

Method Summary

Modifier and Type	Method and Description
Class<BinaryDocument>	documentType()
protected BinaryDocument	doDecode(String id, com.couchbase.client.deps.io.netty.buffer.ByteBuf content, long cas, int expiry, int flags, ResponseStatus status) Perform the decoding of the received response.
protected Tuple2<com.couchbase.client.deps.io.netty.buffer.ByteBuf,Integer>	doEncode(BinaryDocument document) Perform the encoding of the request document.
BinaryDocument	newDocument(String id, int expiry, com.couchbase.client.deps.io.netty.buffer.ByteBuf content, long cas) Creates a new Document with the passed in information.
BinaryDocument	newDocument(String id, int expiry, com.couchbase.client.deps.io.netty.buffer.ByteBuf content, long cas, MutationToken mutationToken) Default implementation for backwards compatibility.
protected boolean	shouldAutoReleaseOnDecode() Flag method to auto release decoded buffers.
protected boolean	shouldAutoReleaseOnError() Flag method to auto release buffers on decoding error.

Methods inherited from class com.couchbase.client.java.transcoder.AbstractTranscoder

decode, encode

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryTranscoder

public BinaryTranscoder()

Method Detail

doDecode

protected BinaryDocument doDecode(String id,
                                  com.couchbase.client.deps.io.netty.buffer.ByteBuf content,
                                  long cas,
                                  int expiry,
                                  int flags,
                                  ResponseStatus status)
                           throws Exception

Description copied from class: AbstractTranscoder

Perform the decoding of the received response.

Specified by:

doDecode in class AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Parameters:

id - the id of the document.

content - the encoded content of the document.

cas - the cas value of the document.

expiry - the expiration time of the document.

flags - the flags set on the document.

status - the response status.

Returns:

the decoded document.

Throws:

Exception - if something goes wrong during the decode process.

doEncode

protected Tuple2<com.couchbase.client.deps.io.netty.buffer.ByteBuf,Integer> doEncode(BinaryDocument document)
                                                                              throws Exception

Description copied from class: AbstractTranscoder

Perform the encoding of the request document.

Specified by:

doEncode in class AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Parameters:

document - the document to encode.

Returns:

A tuple consisting of the encoded content and the flags to set.

Throws:

Exception - if something goes wrong during the encode process.

newDocument

public BinaryDocument newDocument(String id,
                                  int expiry,
                                  com.couchbase.client.deps.io.netty.buffer.ByteBuf content,
                                  long cas)

Description copied from interface: Transcoder

Creates a new Document with the passed in information. Use the one with the mutation token instead (Transcoder.newDocument(String, int, Object, long, MutationToken)).

Parameters:

id - the id of the document.

expiry - the document expiration.

content - the document content.

cas - the documents cas value.

Returns:

the created document.

newDocument

public BinaryDocument newDocument(String id,
                                  int expiry,
                                  com.couchbase.client.deps.io.netty.buffer.ByteBuf content,
                                  long cas,
                                  MutationToken mutationToken)

Description copied from class: AbstractTranscoder

Default implementation for backwards compatibility.

Specified by:

newDocument in interface Transcoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Overrides:

newDocument in class AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Parameters:

id - the id of the document.

expiry - the document expiration.

content - the document content.

cas - the documents cas value.

mutationToken - the documents mutation token.

Returns:

the created document.

documentType

public Class<BinaryDocument> documentType()

shouldAutoReleaseOnDecode

protected boolean shouldAutoReleaseOnDecode()

Description copied from class: AbstractTranscoder

Flag method to auto release decoded buffers. Override to change default behaviour (true).

Overrides:

shouldAutoReleaseOnDecode in class AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Returns:

true if the ByteBuf passed to decode method is to be released automatically on success (default behaviour)

shouldAutoReleaseOnError

protected boolean shouldAutoReleaseOnError()

Description copied from class: AbstractTranscoder

Flag method to auto release buffers on decoding error. Override to change default behaviour (true).

Overrides:

shouldAutoReleaseOnError in class AbstractTranscoder<BinaryDocument,com.couchbase.client.deps.io.netty.buffer.ByteBuf>

Returns:

true if the ByteBuf passed to decode method is to be released automatically in case of error (default behaviour)