com.couchbase.client.core.message.kv.subdoc.multi

Class LookupCommandBuilder

java.lang.Object

com.couchbase.client.core.message.kv.subdoc.multi.LookupCommandBuilder

@InterfaceStability.Committed
 @InterfaceAudience.Public
public class LookupCommandBuilder
extends Object

Builder for LookupCommand

Since:

1.4.2

Author:

Subhashni Balakrishnan

Constructor Summary

Constructors

Constructor and Description
LookupCommandBuilder(Lookup lookup, String path) Create a multi-lookup command.

Method Summary

Modifier and Type	Method and Description
LookupCommand	build()
Lookup	lookup()
byte	opCode()
String	path()
boolean	xattr() Access to extended attribute section of the couchbase document
LookupCommandBuilder	xattr(boolean xattr) Access to extended attribute section of the couchbase document

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupCommandBuilder

public LookupCommandBuilder(Lookup lookup,
                            String path)

Create a multi-lookup command.

Parameters:

lookup - the lookup type.

path - the path to look-up inside the document.

Method Detail

build

public LookupCommand build()

lookup

public Lookup lookup()

path

public String path()

opCode

public byte opCode()

xattr

public boolean xattr()

Access to extended attribute section of the couchbase document

Returns:

true if accessing extended attribute section

xattr

public LookupCommandBuilder xattr(boolean xattr)

Access to extended attribute section of the couchbase document

Returns:

builder with true set for attribute access