com.couchbase.client.java.document.subdoc

Class LookupResult

java.lang.Object

com.couchbase.client.java.document.subdoc.LookupResult

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

A result corresponding to a single LookupSpec, usually grouped inside a MultiLookupResult.

Since:

2.2

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
static LookupResult	createExistResult(String path, ResponseStatus status) Create a LookupResult that corresponds to a EXIST.
static LookupResult	createFatal(String path, Lookup operation, RuntimeException fatal) Create a LookupResult that denotes that a fatal Exception occurred when parsing server-side result.
static LookupResult	createGetResult(String path, ResponseStatus status, Object value) Create a LookupResult that corresponds to a GET.
boolean	exists()
boolean	isFatal()
Lookup	operation()
String	path()
ResponseStatus	status()
Object	value() Returns: - the value retrieved by a successful GET.
Object	valueOrThrow() Returns: - the value retrieved by a successful GET.

Methods inherited from class java.lang.Object

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

Method Detail

createFatal

public static LookupResult createFatal(String path,
                                       Lookup operation,
                                       RuntimeException fatal)

Create a LookupResult that denotes that a fatal Exception occurred when parsing server-side result. The exception can be found as the value, and the status is ResponseStatus.FAILURE.

Parameters:

path - the path looked up.

operation - the lookup operation which result couldn’t be parsed.

fatal - the Exception that occurred during response parsing.

Returns:

the fatal LookupResult.

createGetResult

public static LookupResult createGetResult(String path,
                                           ResponseStatus status,
                                           Object value)

Create a LookupResult that corresponds to a GET.

Parameters:

path - the path looked up.

status - the status of the GET.

value - the value of the GET if successful, null otherwise.

Returns:

the GET LookupResult.

createExistResult

public static LookupResult createExistResult(String path,
                                             ResponseStatus status)

Create a LookupResult that corresponds to a EXIST.

Parameters:

path - the path looked up.

status - the status of the EXIST, its isSuccess giving the LookupResult’s value.

Returns:

the EXIST LookupResult.

path

public String path()

Returns:

the path that was looked up.

operation

public Lookup operation()

Returns:

the exact kind of lookup that was performed.

status

public ResponseStatus status()

Returns:

the status of the lookup.

exists

public boolean exists()

Returns:

true if the value existed (and in the case of a GET, could be retrieved), false otherwise.

value

public Object value()

Returns: - the value retrieved by a successful GET. - null for an unsuccessful GET (see the status() for details). - true/false for an EXIST (equivalent to exists()). - a RuntimeException if the client side parsing of the result failed (isFatal()).

Returns:

the value

See Also:

for a version that throws the exception instead of returning it.

isFatal

public boolean isFatal()

Returns:

true if there was a fatal error while processing the result on the client side, in which case value() returns an RuntimeException.

valueOrThrow

public Object valueOrThrow()

Returns: - the value retrieved by a successful GET. - null for an unsuccessful GET (see the status() for details). - true/false for an EXIST (equivalent to exists()).

Throws: - a RuntimeException if the client side parsing of the result failed (isFatal()).

Returns:

the value

See Also:

for a version that just returns the exception instead of throwing it.