Cursor (couchbase-lite-java-core API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

SQLiteQueryCursor
```
public interface Cursor
extends java.io.Closeable
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIELD_TYPE_BLOB` Value if the specified column type is blob
`static int`	`FIELD_TYPE_FLOAT` Value if the specified column type is float
`static int`	`FIELD_TYPE_INTEGER` Value if the specified column type is integer
`static int`	`FIELD_TYPE_NULL` Value if the specified column is null
`static int`	`FIELD_TYPE_STRING` Value if the specified column type is string

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the Cursor, releasing all of its resources and making it completely invalid.
`byte[]`	`getBlob(int columnIndex)` Returns the value of the requested column as a byte array.
`int`	`getColumnIndex(java.lang.String columnName)` Returns the zero-based index for the given column name, or -1 if the column doesn't exist.
`int`	`getColumnIndexOrThrow(java.lang.String columnName)` Returns the zero-based index for the given column name, or throws `IllegalArgumentException` if the column doesn't exist.
`java.lang.String`	`getColumnName(int columnIndex)` Returns the column name at the given zero-based column index.
`double`	`getDouble(int columnIndex)` Returns the value of the requested column as a double.
`float`	`getFloat(int columnIndex)` Returns the value of the requested column as a float.
`int`	`getInt(int columnIndex)` Returns the value of the requested column as an int.
`long`	`getLong(int columnIndex)` Returns the value of the requested column as a long.
`int`	`getShort(int columnIndex)` Returns the value of the requested column as a short.
`java.lang.String`	`getString(int columnIndex)` Returns the value of the requested column as a String.
`boolean`	`isAfterLast()` Returns whether the cursor is pointing to the position after the last row.
`boolean`	`isNull(int columnIndex)` Returns `true` if the value in the indicated column is null.
`boolean`	`moveToNext()` Move the cursor to the next row.

- Field Detail
  - FIELD_TYPE_NULL
```
static final int FIELD_TYPE_NULL
```
    Value if the specified column is null
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_INTEGER
```
static final int FIELD_TYPE_INTEGER
```
    Value if the specified column type is integer
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_FLOAT
```
static final int FIELD_TYPE_FLOAT
```
    Value if the specified column type is float
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_STRING
```
static final int FIELD_TYPE_STRING
```
    Value if the specified column type is string
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_BLOB
```
static final int FIELD_TYPE_BLOB
```
    Value if the specified column type is blob
    
    See Also:
    
    Constant Field Values
- Method Detail
  - moveToNext
```
boolean moveToNext()
```
    Move the cursor to the next row.
    This method will return false if the cursor is already past the last entry in the result set.
    
    Returns:
    
    whether the move succeeded.
  - isAfterLast
```
boolean isAfterLast()
```
    Returns whether the cursor is pointing to the position after the last row.
    
    Returns:
    
    whether the cursor is after the last result.
  - getColumnIndex
```
int getColumnIndex(java.lang.String columnName)
```
    Returns the zero-based index for the given column name, or -1 if the column doesn't exist. If you expect the column to exist use getColumnIndexOrThrow(String) instead, which will make the error more clear.
    
    Parameters:
    
    columnName - the name of the target column.
    
    Returns:
    
    the zero-based column index for the given column name, or -1 if the column name does not exist.
    
    See Also:
    
    getColumnIndexOrThrow(String)
  - getColumnIndexOrThrow
```
int getColumnIndexOrThrow(java.lang.String columnName)
                   throws java.lang.IllegalArgumentException
```
    Returns the zero-based index for the given column name, or throws IllegalArgumentException if the column doesn't exist. If you're not sure if a column will exist or not use getColumnIndex(String) and check for -1, which is more efficient than catching the exceptions.
    
    Parameters:
    
    columnName - the name of the target column.
    
    Returns:
    
    the zero-based column index for the given column name
    
    Throws:
    
    java.lang.IllegalArgumentException - if the column does not exist
    
    See Also:
    
    getColumnIndex(String)
  - getColumnName
```
java.lang.String getColumnName(int columnIndex)
```
    Returns the column name at the given zero-based column index.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the column name for the given column index.
  - getString
```
java.lang.String getString(int columnIndex)
```
    Returns the value of the requested column as a String.
    The result and whether this method throws an exception when the column value is null or the column type is not a string type is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a String.
  - getShort
```
int getShort(int columnIndex)
```
    Returns the value of the requested column as a short.
    The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Short.MIN_VALUE, Short.MAX_VALUE] is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a short.
  - getInt
```
int getInt(int columnIndex)
```
    Returns the value of the requested column as an int.
    The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Integer.MIN_VALUE, Integer.MAX_VALUE] is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as an int.
  - getLong
```
long getLong(int columnIndex)
```
    Returns the value of the requested column as a long.
    The result and whether this method throws an exception when the column value is null, the column type is not an integral type, or the integer value is outside the range [Long.MIN_VALUE, Long.MAX_VALUE] is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a long.
  - getFloat
```
float getFloat(int columnIndex)
```
    Returns the value of the requested column as a float.
    The result and whether this method throws an exception when the column value is null, the column type is not a floating-point type, or the floating-point value is not representable as a float value is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a float.
  - getDouble
```
double getDouble(int columnIndex)
```
    Returns the value of the requested column as a double.
    The result and whether this method throws an exception when the column value is null, the column type is not a floating-point type, or the floating-point value is not representable as a double value is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a double.
  - getBlob
```
byte[] getBlob(int columnIndex)
```
    Returns the value of the requested column as a byte array.
    The result and whether this method throws an exception when the column value is null or the column type is not a blob type is implementation-defined.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    the value of that column as a byte array.
  - isNull
```
boolean isNull(int columnIndex)
```
    Returns true if the value in the indicated column is null.
    
    Parameters:
    
    columnIndex - the zero-based index of the target column.
    
    Returns:
    
    whether the column value is null.
  - close
```
void close()
```
    Closes the Cursor, releasing all of its resources and making it completely invalid.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable

Interface Cursor

Field Summary

Method Summary

Field Detail

FIELD_TYPE_NULL

FIELD_TYPE_INTEGER

FIELD_TYPE_FLOAT

FIELD_TYPE_STRING

FIELD_TYPE_BLOB

Method Detail

moveToNext

isAfterLast

getColumnIndex

getColumnIndexOrThrow

getColumnName

getString

getShort

getInt

getLong

getFloat

getDouble

getBlob

isNull

close