com.couchbase.client.java.transcoder

Class StringTranscoder

java.lang.Object

com.couchbase.client.java.transcoder.AbstractTranscoder<StringDocument,java.lang.String>

com.couchbase.client.java.transcoder.StringTranscoder

All Implemented Interfaces:

Transcoder<StringDocument,java.lang.String>

public class StringTranscoder
extends AbstractTranscoder<StringDocument,java.lang.String>

A transcoder to encode and decode StringDocuments.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
StringTranscoder()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Class<StringDocument>	documentType()
protected StringDocument	doDecode(java.lang.String id, com.couchbase.client.deps.io.netty.buffer.ByteBuf content, long cas, int expiry, int flags, com.couchbase.client.core.message.ResponseStatus status) Perform the decoding of the received response.
protected com.couchbase.client.core.lang.Tuple2<com.couchbase.client.deps.io.netty.buffer.ByteBuf,java.lang.Integer>	doEncode(StringDocument document) Perform the encoding of the request document.
StringDocument	newDocument(java.lang.String id, int expiry, java.lang.String content, long cas)

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

StringTranscoder

public StringTranscoder()

Method Detail

doDecode

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

Description copied from class: AbstractTranscoder

Perform the decoding of the received response.

Specified by:

doDecode in class AbstractTranscoder<StringDocument,java.lang.String>

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:

java.lang.Exception - if something goes wrong during the decode process.

doEncode

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

Description copied from class: AbstractTranscoder

Perform the encoding of the request document.

Specified by:

doEncode in class AbstractTranscoder<StringDocument,java.lang.String>

Parameters:

document - the document to encode.

Returns:

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

Throws:

java.lang.Exception - if something goes wrong during the encode process.

newDocument

public StringDocument newDocument(java.lang.String id,
                         int expiry,
                         java.lang.String content,
                         long cas)

documentType

public java.lang.Class<StringDocument> documentType()