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

Class LookupResult

java.lang.Object

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

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class LookupResult
extends Object

The result corresponding to an individual LookupCommand. It contains the command’s path and operation for reference.

The value only makes sense for Lookup.GET commands. If it could be found, it is represented as an UTF-8 encoded ByteBuf. It is the responsibility of the caller to consume and ReferenceCounted.release() this ByteBuf.

Since:

1.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
LookupResult(short statusCode, ResponseStatus status, String path, Lookup operation, ByteBuf value)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
Lookup	operation()
String	path()
ResponseStatus	status() Returns the individual operation’s status.
short	statusCode()
String	toString()
ByteBuf	value()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LookupResult

public LookupResult(short statusCode,
                    ResponseStatus status,
                    String path,
                    Lookup operation,
                    ByteBuf value)

Method Detail

statusCode

public short statusCode()

Returns:

the byte status of the individual operation.

status

public ResponseStatus status()

Returns the individual operation’s status.

Note that the containing MultiLookupResponse status can only be ResponseStatus.SUCCESS if all individual LookupResults are a SUCCESS too.

A Lookup.EXIST can either be a SUCCESS if the value exist or a ResponseStatus.SUBDOC_PATH_NOT_FOUND if not.

path

public String path()

Returns:

the path asked for in the original LookupCommand, for reference.

operation

public Lookup operation()

Returns:

the Lookup operation of the original LookupCommand, for reference.

value

public ByteBuf value()

Returns:

the value as a ByteBuf (that you must consume and ReferenceCounted.release()). Can be empty in case of error or if the operation is EXIST.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object