Package com.couchbase.client.java.transcoder

Class JsonTranscoder

java.lang.Object
com.couchbase.client.java.transcoder.AbstractTranscoder<JsonDocument,​JsonObject>
com.couchbase.client.java.transcoder.JsonTranscoder
All Implemented Interfaces:
Transcoder<JsonDocument,​JsonObject>
public class JsonTranscoder
extends AbstractTranscoder<JsonDocument,​JsonObject>
A transcoder to encode and decode JsonDocuments.
Since:
2.0
Author:
Michael Nitschinger

  • Constructor Details

    • JsonTranscoder

      public JsonTranscoder()

  • Method Details

    • documentType

      public Class<JsonDocument> documentType()

    • doEncode

      protected Tuple2<com.couchbase.client.deps.io.netty.buffer.ByteBuf,​Integer> doEncode​(JsonDocument document) throws Exception
      Description copied from class: AbstractTranscoder
      Perform the encoding of the request document.
      Specified by:
      doEncode in class AbstractTranscoder<JsonDocument,​JsonObject>
      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.

    • doDecode

      protected JsonDocument 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<JsonDocument,​JsonObject>
      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.

    • newDocument

      public JsonDocument newDocument​(String id, int expiry, JsonObject 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 JsonDocument newDocument​(String id, int expiry, JsonObject content, long cas, MutationToken mutationToken)
      Description copied from class: AbstractTranscoder
      Default implementation for backwards compatibility.
      Specified by:
      newDocument in interface Transcoder<JsonDocument,​JsonObject>
      Overrides:
      newDocument in class AbstractTranscoder<JsonDocument,​JsonObject>
      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.

    • jsonObjectToString

      public String jsonObjectToString​(JsonObject input) throws Exception
      Throws:
      Exception

    • jsonObjectToByteBuf

      public com.couchbase.client.deps.io.netty.buffer.ByteBuf jsonObjectToByteBuf​(JsonObject input) throws Exception
      Throws:
      Exception

    • stringToJsonObject

      public JsonObject stringToJsonObject​(String input) throws Exception
      Throws:
      Exception

    • byteBufToJsonObject

      public JsonObject byteBufToJsonObject​(com.couchbase.client.deps.io.netty.buffer.ByteBuf input) throws Exception
      Converts a ByteBuf to a JsonObject, without releasing the buffer
      Parameters:
      input - the buffer to convert. It won't be cleared (contrary to classical decode)
      Returns:
      a JsonObject decoded from the buffer
      Throws:
      Exception

    • byteBufJsonValueToObject

      public Object byteBufJsonValueToObject​(com.couchbase.client.deps.io.netty.buffer.ByteBuf input) throws Exception
      Converts a ByteBuf representing a valid JSON entity to a generic Object, without releasing the buffer. The entity can either be a JSON object, array or scalar value, potentially with leading whitespace (which gets ignored). Detection of JSON objects and arrays is attempted in order not to incur an additional conversion step (JSON to Map to JsonObject for example), but if a Map or List is produced, it will be transformed to JsonObject or JsonArray (with a warning logged).
      Parameters:
      input - the buffer to convert. It won't be cleared (contrary to classical decode)
      Returns:
      a Object decoded from the buffer
      Throws:
      Exception