com.couchbase.client.java.document

Class JsonArrayDocument

java.lang.Object

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

com.couchbase.client.java.document.JsonArrayDocument

All Implemented Interfaces:

Document<JsonArray>

public class JsonArrayDocument
extends AbstractDocument<JsonArray>

Stores a properly encoded JSON array 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 JsonArrayDocument	create(java.lang.String id) Creates a JsonDocument which the document id.
static JsonArrayDocument	create(java.lang.String id, int expiry, JsonArray content) Creates a JsonDocument which the document id, JSON content and the expiration time.
static JsonArrayDocument	create(java.lang.String id, int expiry, JsonArray content, long cas) Creates a JsonDocument which the document id, JSON content, CAS value, expiration time and status code.
static JsonArrayDocument	create(java.lang.String id, JsonArray content) Creates a JsonDocument which the document id and JSON content.
static JsonArrayDocument	create(java.lang.String id, JsonArray content, long cas) Creates a JsonDocument which the document id, JSON content and the CAS value.
static JsonArrayDocument	empty() Creates a empty JsonDocument.
static JsonArrayDocument	from(JsonArrayDocument doc, JsonArray content) Creates a copy from a different JsonDocument, but changes the content.
static JsonArrayDocument	from(JsonArrayDocument doc, long cas) Creates a copy from a different JsonDocument, but changes the CAS value.
static JsonArrayDocument	from(JsonArrayDocument doc, java.lang.String id) Creates a copy from a different JsonArrayDocument, but changes the document ID.
static JsonArrayDocument	from(JsonArrayDocument doc, java.lang.String id, JsonArray content) Creates a copy from a different JsonDocument, 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 JsonArrayDocument empty()

Creates a empty JsonDocument.

Returns:

a empty JsonDocument.

create

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

Creates a JsonDocument which the document id.

Parameters:

id - the per-bucket unique document id.

Returns:

a JsonDocument.

create

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

Creates a JsonDocument which the document id and JSON content.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a JsonDocument.

create

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

Creates a JsonDocument which the document id, JSON 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 JsonDocument.

create

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

Creates a JsonDocument which the document id, JSON 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 JsonArrayDocument.

create

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

Creates a JsonDocument which the document id, JSON 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 JsonArrayDocument.

from

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

Creates a copy from a different JsonArrayDocument, but changes the document ID.

Parameters:

doc - the original JsonArrayDocument to copy.

id - the per-bucket unique document id.

Returns:

a copied JsonArrayDocument with the changed properties.

from

public static JsonArrayDocument from(JsonArrayDocument doc,
                     JsonArray content)

Creates a copy from a different JsonDocument, but changes the content.

Parameters:

doc - the original JsonDocument to copy.

content - the content of the document.

Returns:

a copied JsonDocument with the changed properties.

from

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

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

Parameters:

doc - the original JsonDocument to copy.

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a copied JsonDocument with the changed properties.

from

public static JsonArrayDocument from(JsonArrayDocument doc,
                     long cas)

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

Parameters:

doc - the original JsonDocument to copy.

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

Returns:

a copied JsonDocument with the changed properties.