com.couchbase.client.java.document

Class JsonBooleanDocument

java.lang.Object

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

com.couchbase.client.java.document.JsonBooleanDocument

All Implemented Interfaces:

Document<java.lang.Boolean>

public class JsonBooleanDocument
extends AbstractDocument<java.lang.Boolean>

Method Summary

Methods

Modifier and Type	Method and Description
static JsonBooleanDocument	create(java.lang.String id) Creates a JsonBooleanDocument which the document id.
static JsonBooleanDocument	create(java.lang.String id, java.lang.Boolean content) Creates a JsonBooleanDocument which the document id and content.
static JsonBooleanDocument	create(java.lang.String id, java.lang.Boolean content, long cas) Creates a JsonBooleanDocument which the document id, content and the CAS value.
static JsonBooleanDocument	create(java.lang.String id, int expiry, java.lang.Boolean content) Creates a JsonBooleanDocument which the document id, content and the expiration time.
static JsonBooleanDocument	create(java.lang.String id, int expiry, java.lang.Boolean content, long cas) Creates a JsonBooleanDocument which the document id, content, CAS value, expiration time and status code.
static JsonBooleanDocument	empty() Creates a empty JsonBooleanDocument.
static JsonBooleanDocument	from(JsonBooleanDocument doc, java.lang.Boolean content) Creates a copy from a different JsonBooleanDocument, but changes the content.
static JsonBooleanDocument	from(JsonBooleanDocument doc, long cas) Creates a copy from a different JsonBooleanDocument, but changes the CAS value.
static JsonBooleanDocument	from(JsonBooleanDocument doc, java.lang.String id) Creates a copy from a different JsonBooleanDocument, but changes the document ID.
static JsonBooleanDocument	from(JsonBooleanDocument doc, java.lang.String id, java.lang.Boolean content) Creates a copy from a different JsonBooleanDocument, 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 JsonBooleanDocument empty()

Creates a empty JsonBooleanDocument.

Returns:

a empty JsonBooleanDocument.

create

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

Creates a JsonBooleanDocument which the document id.

Parameters:

id - the per-bucket unique document id.

Returns:

a JsonBooleanDocument.

create

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

Creates a JsonBooleanDocument which the document id and content.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a JsonBooleanDocument.

create

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

Creates a JsonBooleanDocument 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 JsonBooleanDocument.

create

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

Creates a JsonBooleanDocument 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 JsonBooleanDocument.

create

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

Creates a JsonBooleanDocument 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 JsonBooleanDocument.

from

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

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

Parameters:

doc - the original JsonBooleanDocument to copy.

id - the per-bucket unique document id.

Returns:

a copied JsonBooleanDocument with the changed properties.

from

public static JsonBooleanDocument from(JsonBooleanDocument doc,
                       java.lang.Boolean content)

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

Parameters:

doc - the original JsonBooleanDocument to copy.

content - the content of the document.

Returns:

a copied JsonBooleanDocument with the changed properties.

from

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

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

Parameters:

doc - the original JsonBooleanDocument to copy.

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a copied JsonBooleanDocument with the changed properties.

from

public static JsonBooleanDocument from(JsonBooleanDocument doc,
                       long cas)

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

Parameters:

doc - the original JsonBooleanDocument to copy.

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

Returns:

a copied JsonBooleanDocument with the changed properties.