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

Class MultiResult<OPERATION>

java.lang.Object

com.couchbase.client.core.message.kv.subdoc.multi.MultiResult<OPERATION>

@Committed
@Public
public class MultiResult<OPERATION>
extends Object

The result corresponding to an individual LookupCommand or MutationCommand. It contains the command's path and operation for reference. The value only makes sense for some commands (like Lookup.GET or Mutation.COUNTER). If it does make sense, 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é

Method Summary

Modifier and Type	Method	Description
static MultiResult<Lookup>	create(short statusCode, ResponseStatus status, String path, Lookup operation, ByteBuf value)
static MultiResult<Mutation>	create(short statusCode, ResponseStatus status, String path, Mutation operation, ByteBuf value)
boolean	equals(Object o)
int	hashCode()
OPERATION	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

Method Detail

create

public static MultiResult<Lookup> create(short statusCode,
                                         ResponseStatus status,
                                         String path,
                                         Lookup operation,
                                         ByteBuf value)

create

public static MultiResult<Mutation> create(short statusCode,
                                           ResponseStatus status,
                                           String path,
                                           Mutation operation,
                                           ByteBuf value)

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 or MutationCommand, for reference.

operation

public OPERATION operation()

Returns:

the Lookup/Mutation operation of the original LookupCommand/MutationCommand, 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 doesn't return a value.

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