com.couchbase.client.java.document

Class JsonStringDocument

java.lang.Object

com.couchbase.client.java.document.AbstractDocument<java.lang.String>

com.couchbase.client.java.document.JsonStringDocument

All Implemented Interfaces:

Document<java.lang.String>

public class JsonStringDocument
extends AbstractDocument<java.lang.String>

Stores a properly encoded JSON scalar quoted string as the toplevel type.

This document works exactly like JsonDocument, but it accepts a different toplevel type. This document is interoperable with other SDKs.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
static JsonStringDocument	create(java.lang.String id) Creates a JsonStringDocument which the document id.
static JsonStringDocument	create(java.lang.String id, int expiry, java.lang.String content) Creates a JsonStringDocument which the document id, content and the expiration time.
static JsonStringDocument	create(java.lang.String id, int expiry, java.lang.String content, long cas) Creates a JsonStringDocument which the document id, content, CAS value, expiration time and status code.
static JsonStringDocument	create(java.lang.String id, java.lang.String content) Creates a JsonStringDocument which the document id and content.
static JsonStringDocument	create(java.lang.String id, java.lang.String content, long cas) Creates a JsonStringDocument which the document id, content and the CAS value.
static JsonStringDocument	empty() Creates a empty JsonStringDocument.
static JsonStringDocument	from(JsonStringDocument doc, long cas) Creates a copy from a different JsonStringDocument, but changes the CAS value.
static JsonStringDocument	from(JsonStringDocument doc, java.lang.String id, java.lang.String content) Creates a copy from a different JsonStringDocument, but changes the document ID and content.

Methods inherited from class com.couchbase.client.java.document.AbstractDocument

cas, content, expiry, id, toString

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static JsonStringDocument empty()

Creates a empty JsonStringDocument.

Returns:

a empty JsonStringDocument.

create

public static JsonStringDocument create(java.lang.String id)

Creates a JsonStringDocument which the document id.

Parameters:

id - the per-bucket unique document id.

Returns:

a JsonStringDocument.

create

public static JsonStringDocument create(java.lang.String id,
                        java.lang.String content)

Creates a JsonStringDocument which the document id and content.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a JsonStringDocument.

create

public static JsonStringDocument create(java.lang.String id,
                        java.lang.String content,
                        long cas)

Creates a JsonStringDocument which the document id, content and the CAS value.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

cas - the CAS (compare and swap) value for optimistic concurrency.

Returns:

a JsonStringDocument.

create

public static JsonStringDocument create(java.lang.String id,
                        int expiry,
                        java.lang.String content)

Creates a JsonStringDocument which the document id, content and the expiration time.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

expiry - the expiration time of the document.

Returns:

a JsonStringDocument.

create

public static JsonStringDocument create(java.lang.String id,
                        int expiry,
                        java.lang.String content,
                        long cas)

Creates a JsonStringDocument which the document id, content, CAS value, expiration time and status code.

This factory method is normally only called within the client library when a response is analyzed and a document is returned which is enriched with the status code. It does not make sense to pre populate the status field from the user level code.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

cas - the CAS (compare and swap) value for optimistic concurrency.

expiry - the expiration time of the document.

Returns:

a JsonStringDocument.

from

public static JsonStringDocument from(JsonStringDocument doc,
                      java.lang.String id,
                      java.lang.String content)

Creates a copy from a different JsonStringDocument, but changes the document ID and content.

Parameters:

doc - the original JsonStringDocument to copy.

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a copied JsonStringDocument with the changed properties.

from

public static JsonStringDocument from(JsonStringDocument doc,
                      long cas)

Creates a copy from a different JsonStringDocument, but changes the CAS value.

Parameters:

doc - the original JsonStringDocument to copy.

cas - the CAS (compare and swap) value for optimistic concurrency.

Returns:

a copied JsonStringDocument with the changed properties.