ScanTerm (Couchbase Java SDK 3.4.6 API)

java.lang.Object
- com.couchbase.client.java.kv.ScanTerm

```
@Volatile
public class ScanTerm
extends Object
```
A single ScanTerm identifying either the point to scan from or to scan to.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`static ScanTerm`	`maximum()`	Returns a scan term representing the absolute maximum pattern (end point).
`static ScanTerm`	`minimum()`	Returns a scan term representing the absolute minimum pattern (starting point).
`CoreScanTerm`	`toCore()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.
  - minimum
```
public static ScanTerm minimum()
```
    Returns a scan term representing the absolute minimum pattern (starting point).
    Equivalent to ScanTerm.inclusive(Character.toString(Character.MIN_CODE_POINT))
    
    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(Character.toString(Character.MAX_CODE_POINT))
    
    Returns:
    
    the absolute maximum ScanTerm.
  - toCore
```
@Internal
public CoreScanTerm toCore()
```