Package com.couchbase.client.java.datastructures

Class MutationOptionBuilder

java.lang.Object

com.couchbase.client.java.datastructures.MutationOptionBuilder

@Committed
@Public
public class MutationOptionBuilder
extends Object

MutationOptionBuilder allows to set following constraints on data structure mutation operations - cas - expiry - persistence - replication - create Document

Since:

2.3.5

Author:

Subhashni Balakrishnan

Method Summary

Modifier and Type	Method	Description
static MutationOptionBuilder	builder()
long	cas()	Get cas stored in option builder Returns cas
MutationOptionBuilder	cas(long cas)	Set cas for optimistic locking on option builder
boolean	createDocument()	Return createDocument option set in mutation option builder Returns createDocument boolean
MutationOptionBuilder	createDocument(boolean createDoc)	createDocument On true, creates the document if it does not exist
int	expiry()	Get expiration stored in option builder Returns expiration time
MutationOptionBuilder	expiry(int expiry)	Set expiration on option builder
PersistTo	persistTo()	Get persistence durability constraints stored in option builder Returns persistence constraint
MutationOptionBuilder	persistTo(PersistTo persistTo)	Set persistence durability constraints on option builder
ReplicateTo	replicateTo()	Get replication durability constraints stored in option builder Returns replication constraint
MutationOptionBuilder	replicateTo(ReplicateTo replicateTo)	Set replication durability constraints on option builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static MutationOptionBuilder builder()

expiry

public MutationOptionBuilder expiry(int expiry)

Set expiration on option builder

Parameters:

expiry - expiration time, 0 means no expiry

expiry

public int expiry()

Get expiration stored in option builder Returns expiration time

cas

public MutationOptionBuilder cas(long cas)

Set cas for optimistic locking on option builder

Parameters:

cas - the CAS to compare

cas

public long cas()

Get cas stored in option builder Returns cas

persistTo

public MutationOptionBuilder persistTo(PersistTo persistTo)

Set persistence durability constraints on option builder

Parameters:

persistTo - persistence constraint

persistTo

public PersistTo persistTo()

Get persistence durability constraints stored in option builder Returns persistence constraint

replicateTo

public MutationOptionBuilder replicateTo(ReplicateTo replicateTo)

Set replication durability constraints on option builder

Parameters:

replicateTo - replication constraint

replicateTo

public ReplicateTo replicateTo()

Get replication durability constraints stored in option builder Returns replication constraint

createDocument

public MutationOptionBuilder createDocument(boolean createDoc)

createDocument On true, creates the document if it does not exist

createDocument

public boolean createDocument()

Return createDocument option set in mutation option builder Returns createDocument boolean