Package com.couchbase.client.java.kv

Class MutationResult

java.lang.Object

com.couchbase.client.java.kv.MutationResult

Direct Known Subclasses:

CounterResult, MutateInResult

public class MutationResult
extends Object

Result returned from all kinds of Key-Value mutation operations.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
long	cas()	Returns the new CAS value of the document after it has been modified successfully.
boolean	equals(Object o)
int	hashCode()
Optional<MutationToken>	mutationToken()	Returns the MutationToken of the document after the performed mutation.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

cas

public long cas()

Returns the new CAS value of the document after it has been modified successfully.

The CAS value is an opaque identifier which is associated with a specific state of the document on the server. It can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.

If document on the server has been modified in the meantime the SDK will raise a CasMismatchException. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.

mutationToken

public Optional<MutationToken> mutationToken()

Returns the MutationToken of the document after the performed mutation.

Note that this value is only present if mutation tokens have been enabled on the environment configuration.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object