com.couchbase.client.java.kv

Class LookupInSpec

java.lang.Object

com.couchbase.client.java.kv.LookupInSpec

Direct Known Subclasses:

LookupInSpecStandard

public abstract class LookupInSpec
extends Object

Defines specs to lookup parts in a JSON document.

Operations allow specifying an empty path ("") which means that the root document level is used (so it will be applied to the full document). By nature it makes sense to only use such a command in isolation, but it can be combined with xattr (extended attributes, a document metadata section) operations as well.

Constructor Summary

Constructors

Constructor and Description
LookupInSpec()

Method Summary

Modifier and Type	Method and Description
static LookupInSpecStandard	count(String path) Counts the number of values at a given path in the document.
static LookupInSpecStandard	exists(String path) Checks if a value at the given path exists in the document.
abstract SubdocGetRequest.Command	export(int originalIndex) Internal operation called from the encoding side that encodes the spec into its internal representation.
static LookupInSpecStandard	get(String path) Fetches the content from a field (if present) at the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupInSpec

public LookupInSpec()

Method Detail

export

@Stability.Internal
public abstract SubdocGetRequest.Command export(int originalIndex)

Internal operation called from the encoding side that encodes the spec into its internal representation.

Parameters:

originalIndex - the original index of the command.

Returns:

the encoded command.

get

public static LookupInSpecStandard get(String path)

Fetches the content from a field (if present) at the given path.

Parameters:

path - the path identifying where to get the value.

Returns:

the created LookupInSpec.

exists

public static LookupInSpecStandard exists(String path)

Checks if a value at the given path exists in the document.

Parameters:

path - the path to check if the field exists.

Returns:

the created LookupInSpec.

count

public static LookupInSpecStandard count(String path)

Counts the number of values at a given path in the document.

Parameters:

path - the path identifying where to count the values.

Returns:

the created LookupInSpec.