Package com.couchbase.client.java.kv
Class ScanTerm
- java.lang.Object
-
- com.couchbase.client.java.kv.ScanTerm
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classScanTerm.Built
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ScanTerm.Builtbuild()booleanexclusive()static ScanTermexclusive(byte[] id)Creates an exclusiveScanTermfrom a byte array.static ScanTermexclusive(String id)Creates an exclusiveScanTermfrom a UTF-8 string.byte[]id()Returns a new byte array containing the key pattern of this term.static ScanTerminclusive(byte[] id)Creates an inclusiveScanTermfrom a byte array.static ScanTerminclusive(String id)Creates an inclusiveScanTermfrom a UTF-8 string.static ScanTermmaximum()Returns a scan term representing the absolute maximum pattern (end point).static ScanTermminimum()Returns a scan term representing the absolute minimum pattern (starting point).
-
-
-
Method Detail
-
id
public byte[] id()
Returns a new byte array containing the key pattern of this term.
-
exclusive
public boolean exclusive()
-
inclusive
public static ScanTerm inclusive(String id)
Creates an inclusiveScanTermfrom a UTF-8 string.- Parameters:
id- the document ID / pattern to use as the scan term.- Returns:
- the created
ScanTerm.
-
inclusive
public static ScanTerm inclusive(byte[] id)
Creates an inclusiveScanTermfrom a byte array.- 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 exclusiveScanTermfrom 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(byte[] id)
Creates an exclusiveScanTermfrom a byte array.- Parameters:
id- the document ID / pattern to use as the scan term.- Returns:
- the created
ScanTerm.
-
minimum
public static ScanTerm minimum()
Returns a scan term representing the absolute minimum pattern (starting point).Equivalent to
ScanTerm.inclusive(new byte[]{(byte) 0x00})- Returns:
- the absolute minimum
ScanTerm.
-
maximum
public static ScanTerm maximum()
Returns a scan term representing the absolute maximum pattern (end point).Equivalent to
ScanTerm.inclusive(new byte[]{(byte) 0xFF})- Returns:
- the absolute maximum
ScanTerm.
-
build
@Internal public ScanTerm.Built build()
-
-