Package com.couchbase.client.java.kv

Class ArrayPrepend

java.lang.Object

com.couchbase.client.java.kv.MutateInSpec

com.couchbase.client.java.kv.ArrayPrepend

public class ArrayPrepend
extends MutateInSpec

An intention to perform a SubDocument array prepend operation.

Since:

1.0.0

Author:

Graham Pople

Method Summary

Modifier and Type	Method	Description
ArrayPrepend	createPath()	Sets that this parent fields should be created automatically.
SubdocMutateRequest.Command	encode(JsonSerializer serializer, int originalIndex)	Internal operation called from the encoding side that encodes the spec into its internal representation.
ArrayPrepend	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 ArrayPrepend xattr()

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

Returns:

this, for chaining

createPath

public ArrayPrepend createPath()

Sets that this parent fields should be created automatically.

Returns:

this, for chaining

encode

public SubdocMutateRequest.Command encode(JsonSerializer serializer,
int originalIndex)

Description copied from class: MutateInSpec

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

Specified by:

encode in class MutateInSpec

Parameters:

serializer - the serializer that should be used.

originalIndex - the original index of the command.

Returns:

the encoded command.