com.couchbase.client.java.document

Class SerializableDocument

java.lang.Object

com.couchbase.client.java.document.AbstractDocument<java.io.Serializable>

com.couchbase.client.java.document.SerializableDocument

All Implemented Interfaces:

Document<java.io.Serializable>

public class SerializableDocument
extends AbstractDocument<java.io.Serializable>

Handles content which implements Serializable.

This document is not interoperable with other SDKs, since java object serialization is not convertible into other programming languages. It is compatible with the legacy object serialization from the 1.* SDK series.

Since:

2.0

Method Summary

Methods

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

Creates a empty SerializableDocument.

Returns:

a empty SerializableDocument.

create

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

Creates a SerializableDocument which the document id.

Parameters:

id - the per-bucket unique document id.

Returns:

a SerializableDocument.

create

public static SerializableDocument create(java.lang.String id,
                          java.io.Serializable content)

Creates a SerializableDocument which the document id and content.

Parameters:

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a SerializableDocument.

create

public static SerializableDocument create(java.lang.String id,
                          java.io.Serializable content,
                          long cas)

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

create

public static SerializableDocument create(java.lang.String id,
                          int expiry,
                          java.io.Serializable content)

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

create

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

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

from

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

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

Parameters:

doc - the original SerializableDocument to copy.

id - the per-bucket unique document id.

Returns:

a copied SerializableDocument with the changed properties.

from

public static SerializableDocument from(SerializableDocument doc,
                        java.lang.Long content)

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

Parameters:

doc - the original SerializableDocument to copy.

content - the content of the document.

Returns:

a copied SerializableDocument with the changed properties.

from

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

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

Parameters:

doc - the original SerializableDocument to copy.

id - the per-bucket unique document id.

content - the content of the document.

Returns:

a copied SerializableDocument with the changed properties.

from

public static SerializableDocument from(SerializableDocument doc,
                        long cas)

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

Parameters:

doc - the original SerializableDocument to copy.

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

Returns:

a copied SerializableDocument with the changed properties.