com.couchbase.client.java.kv

Class ScanTerm

java.lang.Object

com.couchbase.client.java.kv.ScanTerm

@Stability.Volatile
public class ScanTerm
extends Object

A single ScanTerm identifying either the point to scan from or to scan to.

Method Summary

Modifier and Type	Method and Description
boolean	exclusive()
static ScanTerm	exclusive(String id) Creates an exclusive ScanTerm from a UTF-8 string.
String	id() Returns the key pattern of this term.
static ScanTerm	inclusive(String id) Creates an inclusive ScanTerm from a UTF-8 string.
com.couchbase.client.core.kv.CoreScanTerm	toCore()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

id

public String id()

Returns the key pattern of this term.

exclusive

public boolean exclusive()

inclusive

public static ScanTerm inclusive(String id)

Creates an inclusive ScanTerm from a UTF-8 string.

Parameters:

id - the document ID / pattern to use as the scan term.

Returns:

the created ScanTerm.

exclusive

public static ScanTerm exclusive(String id)

Creates an exclusive ScanTerm from a UTF-8 string.

Parameters:

id - the document ID / pattern to use as the scan term.

Returns:

the created ScanTerm.

toCore

@Stability.Internal
public com.couchbase.client.core.kv.CoreScanTerm toCore()

toString

public String toString()

Overrides:

toString in class Object