com.couchbase.client.java.document.subdoc

Class MultiLookupResult

java.lang.Object

com.couchbase.client.java.document.subdoc.MultiLookupResult

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

Compilation of LookupResult each corresponding to a LookupSpec in a given JsonDocument.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
MultiLookupResult(String documentId, List<LookupSpec> specs, List<LookupResult> results) Construct a new MultiLookupResult for a given document, specs and associated results.
MultiLookupResult(String documentId, LookupSpec[] specs, List<LookupResult> results) Construct a new MultiLookupResult for a given document, specs and associated results.

Method Summary

Modifier and Type	Method and Description
String	documentId()
boolean	hasFailure()
boolean	hasSuccess()
boolean	isTotalFailure()
boolean	isTotalSuccess()
List<LookupResult>	results() Returns the list of LookupResult corresponding (in same order) to the specs().
List<LookupSpec>	specs()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiLookupResult

public MultiLookupResult(String documentId,
                         List<LookupSpec> specs,
                         List<LookupResult> results)

Construct a new MultiLookupResult for a given document, specs and associated results.

Parameters:

documentId - the document that was looked up.

specs - the subdocument LookupSpec that targeted the document.

results - the LookupResult associated to each spec, denoting individual success or error.

MultiLookupResult

public MultiLookupResult(String documentId,
                         LookupSpec[] specs,
                         List<LookupResult> results)

Construct a new MultiLookupResult for a given document, specs and associated results.

Parameters:

documentId - the document that was looked up.

specs - the subdocument LookupSpec that targeted the document (as an array, convenience for varargs).

results - the LookupResult associated to each spec, denoting individual success or error.

Method Detail

documentId

public String documentId()

Returns:

the id of the JsonDocument targeted by the lookup.

specs

public List<LookupSpec> specs()

Returns:

the list of LookupSpec that was run on the document.

results

public List<LookupResult> results()

Returns the list of LookupResult corresponding (in same order) to the specs(). Each individual LookupResult denotes success or error of its associated LookupSpec.

Returns:

the list of LookupResult.

hasSuccess

public boolean hasSuccess()

Returns:

true if at least one of the results is a success.

See Also:

hasFailure(), isTotalSuccess()

hasFailure

public boolean hasFailure()

Returns:

true if at least one of the results is a failure.

See Also:

hasSuccess(), isTotalFailure()

isTotalSuccess

public boolean isTotalSuccess()

Returns:

true if ALL the results are successes.

isTotalFailure

public boolean isTotalFailure()

Returns:

true if ALL the results are failures.