Package com.couchbase.client.java.kv

Class ArrayInsert

java.lang.Object

com.couchbase.client.java.kv.MutateInSpec

com.couchbase.client.java.kv.ArrayInsert

public class ArrayInsert
extends MutateInSpec

An intention to perform a SubDocument array insert operation.

Since:

1.0.0

Author:

Graham Pople

Method Summary

Modifier and Type	Method	Description
ArrayInsert	createPath()	Deprecated. Couchbase Server does not support the "create path" option for `ArrayInsert` sub-document operations.
CoreSubdocMutateCommand	toCore(JsonSerializer serializer)	Internal operation called from the encoding side that encodes the spec into its internal representation.
ArrayInsert	xattr()	Sets that this is an extended attribute (xattr) field.

Methods inherited from class com.couchbase.client.java.kv.MutateInSpec

arrayAddUnique, arrayAppend, arrayInsert, arrayPrepend, decrement, increment, insert, remove, replace, upsert

Methods inherited from class java.lang.Object

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

Method Details

xattr

public ArrayInsert xattr()

Sets that this is an extended attribute (xattr) field.

Returns:

this, for chaining

createPath

@Deprecated
public ArrayInsert createPath()

Deprecated.

Couchbase Server does not support the "create path" option for `ArrayInsert` sub-document operations. Calling this method causes `mutateIn` to throw CouchbaseException. Please do not call this method.

If you want to create missing parent objects, please use MutateInSpec.arrayPrepend(java.lang.String, java.util.List<?>) or MutateInSpec.arrayAppend(java.lang.String, java.util.List<?>) instead of MutateInSpec.arrayInsert(java.lang.String, java.util.List<?>).

Requests that any absent parent objects be created automatically.

Returns:

this, for chaining

toCore

public CoreSubdocMutateCommand toCore(JsonSerializer serializer)

Description copied from class: MutateInSpec

Internal operation called from the encoding side that encodes the spec into its internal representation.

Specified by:

toCore in class MutateInSpec

Parameters:

serializer - the serializer that should be used.

Returns:

the encoded command.