Package com.couchbase.client.java.document

Class JsonStringDocument

java.lang.Object

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

com.couchbase.client.java.document.JsonStringDocument

All Implemented Interfaces:

Document<String>, Serializable

public class JsonStringDocument
extends AbstractDocument<String>
implements Serializable

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

Author:

Michael Nitschinger

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static JsonStringDocument	create(String id)	Creates a JsonStringDocument which the document id.
static JsonStringDocument	create(String id, int expiry, String content)	Creates a JsonStringDocument which the document id, content and the expiration time.
static JsonStringDocument	create(String id, int expiry, String content, long cas)	Creates a JsonStringDocument which the document id, content, CAS value, expiration time and status code.
static JsonStringDocument	create(String id, int expiry, String content, long cas, MutationToken mutationToken)	Creates a JsonStringDocument which the document id, content, CAS value, expiration time and status code.
static JsonStringDocument	create(String id, String content)	Creates a JsonStringDocument which the document id and content.
static JsonStringDocument	create(String id, String content, long cas)	Creates a JsonStringDocument which the document id, content and the CAS value.
static JsonStringDocument	from(JsonStringDocument doc, long cas)	Creates a copy from a different JsonStringDocument, but changes the CAS value.
static JsonStringDocument	from(JsonStringDocument doc, String id, 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, equals, expiry, hashCode, id, mutationToken, readFromSerializedStream, toString, writeToSerializedStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static JsonStringDocument create(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(String id,
                                        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(String id,
                                        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(String id,
                                        int expiry,
                                        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(String id,
                                        int expiry,
                                        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.

create

public static JsonStringDocument create(String id,
                                        int expiry,
                                        String content,
                                        long cas,
                                        MutationToken mutationToken)

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,
                                      String id,
                                      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.