Added in API level 1

CursorWrapper


open class CursorWrapper : Cursor
kotlin.Any
   ↳ android.database.CursorWrapper

Wrapper class for Cursor that delegates all calls to the actual cursor object. The primary use for this class is to extend a cursor while overriding only a subset of its methods.

Summary

Inherited constants
Public constructors

Creates a cursor wrapper.

Public methods
open Unit

open Unit
copyStringToBuffer(columnIndex: Int, buffer: CharArrayBuffer!)

open Unit

open ByteArray!
getBlob(columnIndex: Int)

open Int

open Int
getColumnIndex(columnName: String!)

open Int

open String!
getColumnName(columnIndex: Int)

open Array<String!>!

open Int

open Double
getDouble(columnIndex: Int)

open Bundle!

open Float
getFloat(columnIndex: Int)

open Int
getInt(columnIndex: Int)

open Long
getLong(columnIndex: Int)

open Uri!

open MutableList<Uri!>?

open Int

open Short
getShort(columnIndex: Int)

open String!
getString(columnIndex: Int)

open Int
getType(columnIndex: Int)

open Boolean

open Cursor!

Gets the underlying cursor that is wrapped by this instance.

open Boolean

open Boolean

open Boolean

open Boolean

open Boolean

open Boolean
isNull(columnIndex: Int)

open Boolean
move(offset: Int)

open Boolean

open Boolean

open Boolean

open Boolean
moveToPosition(position: Int)

open Boolean

open Unit

open Unit

open Boolean

open Bundle!
respond(extras: Bundle!)

open Unit
setExtras(extras: Bundle!)

open Unit

open Unit

open Unit

open Unit

Public constructors

CursorWrapper

Added in API level 1
CursorWrapper(cursor: Cursor!)

Creates a cursor wrapper.

Parameters
cursor Cursor!: The underlying cursor to wrap.

Public methods

close

Added in API level 1
open fun close(): Unit
Exceptions
java.lang.Exception if this resource cannot be closed
java.io.IOException if an I/O error occurs

copyStringToBuffer

Added in API level 1
open fun copyStringToBuffer(
    columnIndex: Int,
    buffer: CharArrayBuffer!
): Unit
Parameters
columnIndex Int: the zero-based index of the target column. if the target column is null, return buffer Value is 0 or greater
buffer CharArrayBuffer!: the buffer to copy the text into.

deactivate

Added in API level 1
open fun deactivate(): Unit

Deprecated: Deprecated in Java.

getBlob

Added in API level 1
open fun getBlob(columnIndex: Int): ByteArray!
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
ByteArray! the value of that column as a byte array.

getColumnCount

Added in API level 1
open fun getColumnCount(): Int
Return
Int number of columns Value is 0 or greater

getColumnIndex

Added in API level 1
open fun getColumnIndex(columnName: String!): Int
Parameters
columnName String!: the name of the target column.
Return
Int the zero-based column index for the given column name, or -1 if the column name does not exist. Value is -1 or greater

getColumnIndexOrThrow

Added in API level 1
open fun getColumnIndexOrThrow(columnName: String!): Int
Parameters
columnName String!: the name of the target column.
Return
Int the zero-based column index for the given column name Value is 0 or greater
Exceptions
java.lang.IllegalArgumentException if the column does not exist

getColumnName

Added in API level 1
open fun getColumnName(columnIndex: Int): String!
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
String! the column name for the given column index.

getColumnNames

Added in API level 1
open fun getColumnNames(): Array<String!>!
Return
Array<String!>! the names of the columns returned in this query.

getCount

Added in API level 1
open fun getCount(): Int
Return
Int the number of rows in the cursor. Value is 0 or greater

getDouble

Added in API level 1
open fun getDouble(columnIndex: Int): Double
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Double the value of that column as a double.

getExtras

Added in API level 1
open fun getExtras(): Bundle!
Return
Bundle! cursor-defined values, or Bundle.EMPTY if there are no values. Never null.

getFloat

Added in API level 1
open fun getFloat(columnIndex: Int): Float
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Float the value of that column as a float.

getInt

Added in API level 1
open fun getInt(columnIndex: Int): Int
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Int the value of that column as an int.

getLong

Added in API level 1
open fun getLong(columnIndex: Int): Long
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Long the value of that column as a long.

getNotificationUri

Added in API level 19
open fun getNotificationUri(): Uri!
Return
Uri! Returns a URI that can be used with ContentResolver.registerContentObserver to find out about changes to this Cursor's data. May be null if no notification URI has been set.

getNotificationUris

Added in API level 29
open fun getNotificationUris(): MutableList<Uri!>?
Return
MutableList<Uri!>? Returns URIs that can be used with ContentResolver.registerContentObserver to find out about changes to this Cursor's data. May be null if no notification URI has been set.

getPosition

Added in API level 1
open fun getPosition(): Int
Return
Int the current cursor position. Value is -1 or greater

getShort

Added in API level 1
open fun getShort(columnIndex: Int): Short
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Short the value of that column as a short.

getString

Added in API level 1
open fun getString(columnIndex: Int): String!
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
String! the value of that column as a String.

getType

Added in API level 11
open fun getType(columnIndex: Int): Int
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Int column value type Value is android.database.Cursor#FIELD_TYPE_NULL, android.database.Cursor#FIELD_TYPE_INTEGER, android.database.Cursor#FIELD_TYPE_FLOAT, android.database.Cursor#FIELD_TYPE_STRING, or android.database.Cursor#FIELD_TYPE_BLOB

getWantsAllOnMoveCalls

Added in API level 1
open fun getWantsAllOnMoveCalls(): Boolean
Return
Boolean whether all cursor movement should result in a call to onMove().

getWrappedCursor

Added in API level 11
open fun getWrappedCursor(): Cursor!

Gets the underlying cursor that is wrapped by this instance.

Return
Cursor! The wrapped cursor.

isAfterLast

Added in API level 1
open fun isAfterLast(): Boolean
Return
Boolean whether the cursor is after the last result.

isBeforeFirst

Added in API level 1
open fun isBeforeFirst(): Boolean
Return
Boolean whether the cursor is before the first result.

isClosed

Added in API level 1
open fun isClosed(): Boolean
Return
Boolean true if the cursor is closed.

isFirst

Added in API level 1
open fun isFirst(): Boolean
Return
Boolean whether the cursor is pointing at the first entry.

isLast

Added in API level 1
open fun isLast(): Boolean
Return
Boolean whether the cursor is pointing at the last entry.

isNull

Added in API level 1
open fun isNull(columnIndex: Int): Boolean
Parameters
columnIndex Int: the zero-based index of the target column. Value is 0 or greater
Return
Boolean whether the column value is null.

move

Added in API level 1
open fun move(offset: Int): Boolean
Parameters
offset Int: the offset to be applied from the current position.
Return
Boolean whether the requested move fully succeeded.

moveToFirst

Added in API level 1
open fun moveToFirst(): Boolean
Return
Boolean whether the move succeeded.

moveToLast

Added in API level 1
open fun moveToLast(): Boolean
Return
Boolean whether the move succeeded.

moveToNext

Added in API level 1
open fun moveToNext(): Boolean
Return
Boolean whether the move succeeded.

moveToPosition

Added in API level 1
open fun moveToPosition(position: Int): Boolean
Parameters
position Int: the zero-based position to move to. Value is -1 or greater
Return
Boolean whether the requested move fully succeeded.

moveToPrevious

Added in API level 1
open fun moveToPrevious(): Boolean
Return
Boolean whether the move succeeded.

registerContentObserver

Added in API level 1
open fun registerContentObserver(observer: ContentObserver!): Unit
Parameters
observer ContentObserver!: the object that gets notified when the content backing the cursor changes.

registerDataSetObserver

Added in API level 1
open fun registerDataSetObserver(observer: DataSetObserver!): Unit
Parameters
observer DataSetObserver!: the object that gets notified when the cursors data set changes.

requery

Added in API level 1
open fun requery(): Boolean

Deprecated: Deprecated in Java.

Return
Boolean true if the requery succeeded, false if not, in which case the cursor becomes invalid.

respond

Added in API level 1
open fun respond(extras: Bundle!): Bundle!
Parameters
extras Bundle!: extra values, or Bundle.EMPTY. Never null.
Return
Bundle! extra values, or Bundle.EMPTY. Never null.

setExtras

Added in API level 23
open fun setExtras(extras: Bundle!): Unit
Parameters
extras Bundle!: Bundle to set, or null to set an empty bundle.

setNotificationUri

Added in API level 1
open fun setNotificationUri(
    cr: ContentResolver!,
    uri: Uri!
): Unit
Parameters
cr ContentResolver!: The content resolver from the caller's context. The listener attached to this resolver will be notified.
uri Uri!: The content URI to watch.

setNotificationUris

Added in API level 29
open fun setNotificationUris(
    cr: ContentResolver,
    uris: MutableList<Uri!>
): Unit
Parameters
cr ContentResolver: The content resolver from the caller's context. The listener attached to this resolver will be notified. This value cannot be null.
uris MutableList<Uri!>: The content URIs to watch. This value cannot be null.

unregisterContentObserver

Added in API level 1
open fun unregisterContentObserver(observer: ContentObserver!): Unit
Parameters
observer ContentObserver!: the object to unregister.

unregisterDataSetObserver

Added in API level 1
open fun unregisterDataSetObserver(observer: DataSetObserver!): Unit
Parameters
observer DataSetObserver!: the object to unregister.