com.couchbase.client.java.document.subdoc

Class MutationSpec<T>

java.lang.Object

com.couchbase.client.java.document.subdoc.MutationSpec<T>

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class MutationSpec<T>
extends Object

Utility class to create specs for the sub-document API’s multi-mutation operations.

Since:

2.2

Author:

Michael Nitschinger, Simon Baslé

Method Summary

Modifier and Type	Method and Description
static <T> MutationSpec	addUnique(String path, T value, boolean createParents) Creates a MutationSpec to insert a value in an existing array only if the value isn’t already contained in the array (by way of string comparison).
static <T> MutationSpec	arrayInsert(String path, T value) Creates a MutationSpec to insert into an existing array at a specific position (denoted in the path, eg.
static MutationSpec<Long>	counter(String path, long delta, boolean createParents) Creates a MutationSpec to increment/decrement a numerical fragment in a JSON document.
boolean	createParents()
static <T> MutationSpec	extend(String path, T value, ExtendDirection direction, boolean createParents) Creates a MutationSpec to extend an existing array, prepending or appending the value depending on the given direction.
T	fragment()
static <T> MutationSpec	insert(String path, T fragment, boolean createParents) Creates a MutationSpec to insert a fragment provided the last element of the path doesn’t exists.
String	path()
static <T> MutationSpec	remove(String path) Creates a MutationSpec to remove an entry in a JSON document (scalar, array element, dictionary entry, whole array or dictionary, depending on the path).
static <T> MutationSpec	replace(String path, T fragment) Creates a MutationSpec to replace an existing value by the fragment.
String	toString()
Mutation	type()
static <T> MutationSpec	upsert(String path, T fragment, boolean createParents) Creates a MutationSpec to insert a fragment, replacing the old value if the path exists.

Methods inherited from class java.lang.Object

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

Method Detail

type

public Mutation type()

Returns:

the type of the mutation.

path

public String path()

Returns:

the path targeted by the mutation.

fragment

public T fragment()

Returns:

the fragment value to apply as a mutation.

createParents

public boolean createParents()

Returns:

true should the mutation create missing intermediary elements in the path (if it supports it).

toString

public String toString()

Overrides:

toString in class Object

replace

public static <T> MutationSpec replace(String path,
                                       T fragment)

Creates a MutationSpec to replace an existing value by the fragment.

See Also:

Bucket.replaceIn(DocumentFragment, PersistTo, ReplicateTo)

upsert

public static <T> MutationSpec upsert(String path,
                                      T fragment,
                                      boolean createParents)

Creates a MutationSpec to insert a fragment, replacing the old value if the path exists.

Parameters:

createParents - in case elements of the path other than the last one don’t exist, set to true to create them.

See Also:

Bucket.upsertIn(DocumentFragment, boolean, PersistTo, ReplicateTo)

insert

public static <T> MutationSpec insert(String path,
                                      T fragment,
                                      boolean createParents)

Creates a MutationSpec to insert a fragment provided the last element of the path doesn’t exists.

Parameters:

createParents - in case elements of the path other than the last one don’t exist, set to true to create them.

See Also:

Bucket.insertIn(DocumentFragment, boolean, PersistTo, ReplicateTo)

extend

public static <T> MutationSpec extend(String path,
                                      T value,
                                      ExtendDirection direction,
                                      boolean createParents)

Creates a MutationSpec to extend an existing array, prepending or appending the value depending on the given direction.

Parameters:

direction - the position at which to extend the array.

createParents - in case elements of the path other than the last one don’t exist, set to true to create them.

See Also:

Bucket.extendIn(DocumentFragment, ExtendDirection, boolean, PersistTo, ReplicateTo)

arrayInsert

public static <T> MutationSpec arrayInsert(String path,
                                           T value)

Creates a MutationSpec to insert into an existing array at a specific position (denoted in the path, eg. “sub.array[2]”).

See Also:

Bucket.arrayInsertIn(DocumentFragment, PersistTo, ReplicateTo)

addUnique

public static <T> MutationSpec addUnique(String path,
                                         T value,
                                         boolean createParents)

Creates a MutationSpec to insert a value in an existing array only if the value isn’t already contained in the array (by way of string comparison).

See Also:

Bucket.addUniqueIn(DocumentFragment, boolean, PersistTo, ReplicateTo)

counter

public static MutationSpec<Long> counter(String path,
                                         long delta,
                                         boolean createParents)

Creates a MutationSpec to increment/decrement a numerical fragment in a JSON document. If the value (last element of the path) doesn’t exist the counter is created and takes the value of the delta.

Parameters:

delta - the value to increment or decrement the counter by.

See Also:

Bucket.counterIn(DocumentFragment, boolean, PersistTo, ReplicateTo)

remove

public static <T> MutationSpec remove(String path)

Creates a MutationSpec to remove an entry in a JSON document (scalar, array element, dictionary entry, whole array or dictionary, depending on the path).

See Also:

Bucket.removeIn(DocumentFragment, PersistTo, ReplicateTo)