com.couchbase.client.java.subdoc

Class LookupInBuilder

java.lang.Object

com.couchbase.client.java.subdoc.LookupInBuilder

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

A builder for subdocument lookups. In order to perform the final set of operations, use the execute() method. Operations are performed synchronously (see AsyncLookupInBuilder for an asynchronous version).

Instances of this builder should be obtained through Bucket.lookupIn(String) rather than directly constructed.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
LookupInBuilder(AsyncLookupInBuilder async, long defaultTimeout, TimeUnit defaultTimeUnit) Instances of this builder should be obtained through Bucket.lookupIn(String) rather than directly constructed.

Method Summary

Modifier and Type	Method and Description
DocumentFragment<Lookup>	execute() Perform several lookup operations inside a single existing JSON document, using the default key/value timeout.
DocumentFragment<Lookup>	execute(long timeout, TimeUnit timeUnit) Perform several lookup operations inside a single existing JSON document, using a specific timeout.
LookupInBuilder	exists(String... paths) Check if a value exists inside the document (if it does not, attempting to get the DocumentFragment.content(int) will raise an error).
LookupInBuilder	get(String... paths) Get a value inside the JSON document.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupInBuilder

@InterfaceAudience.Private
public LookupInBuilder(AsyncLookupInBuilder async,
                                                  long defaultTimeout,
                                                  TimeUnit defaultTimeUnit)

Instances of this builder should be obtained through Bucket.lookupIn(String) rather than directly constructed.

Method Detail

execute

public DocumentFragment<Lookup> execute()

Perform several lookup operations inside a single existing JSON document, using the default key/value timeout. The list of path to look for inside the JSON is constructed through builder methods get(String...) and exists(String...).

The subdocument API has the benefit of only transmitting the fragment of the document you work with on the wire, instead of the whole document.

If multiple operations are specified, each spec will receive an answer, overall contained in a DocumentFragment, meaning that if sub-document level error conditions happen (like the path is malformed or doesn’t exist), the whole operation still succeeds.

If a single operation is specified, then any error other that a path not found will throw the corresponding SubDocumentException. Otherwise a DocumentFragment is returned.

Calling DocumentFragment.content(String) or one of its variants on a failed spec/path will throw the corresponding SubDocumentException. For successful gets, it will return the value (or null in the case of a path not found, and only in this case). For exists, it will return true (or false for a path not found).

To check for any error without throwing an exception, use DocumentFragment.status(String) (or its index-based variant).

To check that a given path (or index) is valid for calling content() on it without raising an Exception, use DocumentFragment.exists(String).

One special fatal error can also happen, when the value couldn’t be decoded from JSON. In that case, the ResponseStatus for the path is ResponseStatus.FAILURE and the content(path) will throw a TranscodingException.

This operation throws under the following notable error conditions:

• The enclosing document does not exist: DocumentDoesNotExistException
• The enclosing document is not JSON: DocumentNotJsonException
• No lookup was defined through the builder API: IllegalArgumentException

Other document-level error conditions are similar to those encountered during a document-level AsyncBucket.get(String).

Returns:

a single DocumentFragment representing the whole list of results (1 for each spec), unless a document-level error happened (in which case an exception is thrown).

execute

public DocumentFragment<Lookup> execute(long timeout,
                                        TimeUnit timeUnit)

Perform several lookup operations inside a single existing JSON document, using a specific timeout. The list of path to look for inside the JSON is constructed through builder methods get(String...) and exists(String...).

The subdocument API has the benefit of only transmitting the fragment of the document you work with on the wire, instead of the whole document.

If multiple operations are specified, each spec will receive an answer, overall contained in a DocumentFragment, meaning that if sub-document level error conditions happen (like the path is malformed or doesn’t exist), the whole operation still succeeds.

If a single operation is specified, then any error other that a path not found will throw the corresponding SubDocumentException. Otherwise a DocumentFragment is returned.

Calling DocumentFragment.content(String) or one of its variants on a failed spec/path will throw the corresponding SubDocumentException. For successful gets, it will return the value (or null in the case of a path not found, and only in this case). For exists, it will return true (or false for a path not found).

To check for any error without throwing an exception, use DocumentFragment.status(String) (or its index-based variant).

To check that a given path (or index) is valid for calling content() on it without raising an Exception, use DocumentFragment.exists(String).

One special fatal error can also happen, when the value couldn’t be decoded from JSON. In that case, the ResponseStatus for the path is ResponseStatus.FAILURE and the content(path) will throw a TranscodingException.

This operation throws under the following notable error conditions:

• The enclosing document does not exist: DocumentDoesNotExistException
• The enclosing document is not JSON: DocumentNotJsonException
• No lookup was defined through the builder API: IllegalArgumentException

Other document-level error conditions are similar to those encountered during a document-level AsyncBucket.get(String).

Parameters:

timeout - the specific timeout to apply for the operation.

timeUnit - the time unit for the timeout.

Returns:

a single DocumentFragment representing the whole list of results (1 for each spec), unless a document-level error happened (in which case an exception is thrown).

get

public LookupInBuilder get(String... paths)

Get a value inside the JSON document.

Parameters:

paths - the paths inside the document where to get the value from.

Returns:

this builder for chaining.

exists

public LookupInBuilder exists(String... paths)

Check if a value exists inside the document (if it does not, attempting to get the DocumentFragment.content(int) will raise an error). This doesn’t transmit the value on the wire if it exists, saving the corresponding byte overhead.

Parameters:

paths - the paths inside the document to check for existence.

Returns:

this builder for chaining.

toString

public String toString()

Overrides:

toString in class Object