com.cloudant.sync.datastore

Interface DocumentBody

public interface DocumentBody

Interface for DocumentRevisionTree body. It is logically a JSON document, and physically stored as a blob underneath.

DocumentBody performs a simple serialization/de-serialization between Map<String, Object> and byte[].

1. Text literals are de-serialised as java.lang.String.
2. Integer number are converted to Integer or Longif it is bigger than Integer.MAX_VALUE or smaller than Integer.MIN_VALUE.
3. Decimal number are de-serialised as Double.

If there is any exception with serialization/de-serialization, the entire data will be ignored, and an empty DocumentBody will be created.

Field names starting with _ are reserved for internal use, and must not be modified by client code.

Changing the data stored within this object will not result in changes to the database unless explicitly saved as a new revision.

API Status: Public

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Returns copy of the data as a byte array.
java.util.Map<java.lang.String,java.lang.Object>	asMap() Returns a shallow copy of the underlying data as a map.

Method Detail

asMap

java.util.Map<java.lang.String,java.lang.Object> asMap()

Returns a shallow copy of the underlying data as a map.

Modifying the map below the first level will be visible to other users of the DocumentBody object and so should be avoided.

Returns:

shallow copy of the data as a Map.

asBytes

byte[] asBytes()

Returns copy of the data as a byte array.

Modifying this data will not affect the data for the DocumentBody.

Returns:

copy of the data as byte array