ScanCursor (Lettuce 6.3.3.BUILD-SNAPSHOT API)

java.lang.Object
- io.lettuce.core.ScanCursor

Direct Known Subclasses:

KeyScanCursor, MapScanCursor, ScoredValueScanCursor, StreamScanCursor, ValueScanCursor
```
public class ScanCursor
extends Object
```
Generic Cursor data structure.

Since:

3.0

Author:

Mark Paluch

Field Summary

Fields
Modifier and Type Field Description

static ScanCursor FINISHED
Finished cursor.

static ScanCursor INITIAL
Initial cursor.

Constructor Summary

Constructors
Constructor Description

ScanCursor()
Creates a new ScanCursor.

ScanCursor(String cursor, boolean finished)
Creates a new ScanCursor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCursor()`
`boolean`	`isFinished()`
`static ScanCursor`	`of(String cursor)`	Creates a Scan-Cursor reference.
`void`	`setCursor(String cursor)`	Set the cursor
`void`	`setFinished(boolean finished)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FINISHED
```
public static final ScanCursor FINISHED
```
    Finished cursor.
  - INITIAL
```
public static final ScanCursor INITIAL
```
    Initial cursor.
- Constructor Detail
  - ScanCursor
```
public ScanCursor()
```
    Creates a new ScanCursor.
  - ScanCursor
```
public ScanCursor(String cursor,
                  boolean finished)
```
    Creates a new ScanCursor.
    
    Parameters:
    
    cursor -
    
    finished -
- Method Detail
  - getCursor
```
public String getCursor()
```
    Returns:
    
    cursor id
  - setCursor
```
public void setCursor(String cursor)
```
    Set the cursor
    
    Parameters:
    
    cursor - the cursor id
  - isFinished
```
public boolean isFinished()
```
    Returns:
    
    true if the scan operation of this cursor is finished.
  - setFinished
```
public void setFinished(boolean finished)
```
  - of
```
public static ScanCursor of(String cursor)
```
    Creates a Scan-Cursor reference.
    
    Parameters:
    
    cursor - the cursor id
    
    Returns:
    
    ScanCursor