AbstractCursor

AbstractCursor

AbstractCursor()

close

open fun close(): Unit

Closes the Cursor, releasing all of its resources and making it completely invalid. Unlike deactivate() a call to requery() will not make the Cursor valid again.

copyStringToBuffer

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

Retrieves the requested column text and stores it in the buffer provided. If the buffer size is not sufficient, a new char buffer will be allocated and assigned to CharArrayBuffer.data

deactivate

open fun deactivate(): Unit

Deactivates the Cursor, making all calls on it fail until requery is called. Inactive Cursors use fewer resources than active Cursors. Calling requery will make the cursor active again.

fillWindow

open fun fillWindow(
    position: Int, 
    window: CursorWindow!
): Unit

Copies cursor data into the window.

Clears the window and fills it with data beginning at the requested row position until all of the data in the cursor is exhausted or the window runs out of space.

The filled window uses the same row indices as the original cursor. For example, if you fill a window starting from row 5 from the cursor, you can query the contents of row 5 from the window just by asking it for row 5 because there is a direct correspondence between the row indices used by the cursor and the window.

The current position of the cursor, as returned by getPosition, is not changed by this method.

getBlob

open fun getBlob(column: Int): ByteArray!

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.

getColumnCount

open fun getColumnCount(): Int

Return total number of columns

getColumnIndex

open fun getColumnIndex(columnName: String!): Int

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(java.lang.String) instead, which will make the error more clear.

getColumnIndexOrThrow

open fun getColumnIndexOrThrow(columnName: String!): Int

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(java.lang.String) and check for -1, which is more efficient than catching the exceptions.

getColumnName

open fun getColumnName(columnIndex: Int): String!

Returns the column name at the given zero-based column index.

getColumnNames

abstract fun getColumnNames(): Array<String!>!

Returns a string array holding the names of all of the columns in the result set in the order in which they were listed in the result.

getCount

abstract fun getCount(): Int

Returns the numbers of rows in the cursor.

getDouble

abstract fun getDouble(column: Int): Double

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.

getExtras

open fun getExtras(): Bundle!

Returns a bundle of extra values. This is an optional way for cursors to provide out-of-band metadata to their users. One use of this is for reporting on the progress of network requests that are required to fetch data for the cursor.

These values may only change when requery is called.

getFloat

abstract fun getFloat(column: Int): Float

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.

getInt

abstract fun getInt(column: Int): Int

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.

getLong

abstract fun getLong(column: Int): Long

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.

getNotificationUri

open fun getNotificationUri(): Uri!

Return the URI at which notifications of changes in this Cursor's data will be delivered, as previously set by setNotificationUri.

getNotificationUris

open fun getNotificationUris(): MutableList<Uri!>?

Return the URIs at which notifications of changes in this Cursor's data will be delivered, as previously set by setNotificationUris.

If this is not implemented, this is equivalent to calling getNotificationUri().

getPosition

fun getPosition(): Int

Returns the current position of the cursor in the row set. The value is zero-based. When the row set is first returned the cursor will be at positon -1, which is before the first row. After the last row is returned another call to next() will leave the cursor past the last entry, at a position of count().

getShort

abstract fun getShort(column: Int): Short

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.

getString

abstract fun getString(column: Int): String!

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.

getType

open fun getType(column: Int): Int

Returns data type of the given column's value. The preferred type of the column is returned but the data may be converted to other types as documented in the get-type methods such as getInt(int), getFloat(int) etc.

getWantsAllOnMoveCalls

open fun getWantsAllOnMoveCalls(): Boolean

onMove() will only be called across processes if this method returns true.

getWindow

open fun getWindow(): CursorWindow!

If the cursor is backed by a CursorWindow, returns a pre-filled window with the contents of the cursor, otherwise null.

isAfterLast

fun isAfterLast(): Boolean

Returns whether the cursor is pointing to the position after the last row.

isBeforeFirst

fun isBeforeFirst(): Boolean

Returns whether the cursor is pointing to the position before the first row.

isClosed

open fun isClosed(): Boolean

return true if the cursor is closed

isFirst

fun isFirst(): Boolean

Returns whether the cursor is pointing to the first row.

isLast

fun isLast(): Boolean

Returns whether the cursor is pointing to the last row.

isNull

abstract fun isNull(column: Int): Boolean

Returns true if the value in the indicated column is null.

move

fun move(offset: Int): Boolean

Move the cursor by a relative amount, forward or backward, from the current position. Positive offsets move forwards, negative offsets move backwards. If the final position is outside of the bounds of the result set then the resultant position will be pinned to -1 or count() depending on whether the value is off the front or end of the set, respectively.

This method will return true if the requested destination was reachable, otherwise, it returns false. For example, if the cursor is at currently on the second entry in the result set and move(-5) is called, the position will be pinned at -1, and false will be returned.

moveToFirst

fun moveToFirst(): Boolean

Move the cursor to the first row.

This method will return false if the cursor is empty.

moveToLast

fun moveToLast(): Boolean

Move the cursor to the last row.

This method will return false if the cursor is empty.

moveToNext

fun moveToNext(): Boolean

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.

moveToPosition

fun moveToPosition(position: Int): Boolean

Move the cursor to an absolute position. The valid range of values is -1 <= position <= count.

This method will return true if the request destination was reachable, otherwise, it returns false.

moveToPrevious

fun moveToPrevious(): Boolean

Move the cursor to the previous row.

This method will return false if the cursor is already before the first entry in the result set.

onMove

open fun onMove(
    oldPosition: Int, 
    newPosition: Int
): Boolean

This function is called every time the cursor is successfully scrolled to a new position, giving the subclass a chance to update any state it may have. If it returns false the move function will also do so and the cursor will scroll to the beforeFirst position.

registerContentObserver

open fun registerContentObserver(observer: ContentObserver!): Unit

Register an observer that is called when changes happen to the content backing this cursor. Typically the data set won't change until requery() is called.

registerDataSetObserver

open fun registerDataSetObserver(observer: DataSetObserver!): Unit

Register an observer that is called when changes happen to the contents of the this cursors data set, for example, when the data set is changed via requery(), deactivate(), or #close().

requery

open fun requery(): Boolean

Performs the query that created the cursor again, refreshing its contents. This may be done at any time, including after a call to deactivate. Since this method could execute a query on the database and potentially take a while, it could cause ANR if it is called on Main (UI) thread. A warning is printed if this method is being executed on Main thread.

respond

open fun respond(extras: Bundle!): Bundle!

This is an out-of-band way for the user of a cursor to communicate with the cursor. The structure of each bundle is entirely defined by the cursor.

One use of this is to tell a cursor that it should retry its network request after it reported an error.

setExtras

open fun setExtras(extras: Bundle!): Unit

Sets a Bundle that will be returned by getExtras().

setNotificationUri

open fun setNotificationUri(
    cr: ContentResolver!, 
    notifyUri: Uri!
): Unit

Specifies a content URI to watch for changes.

setNotificationUris

open fun setNotificationUris(
    cr: ContentResolver, 
    notifyUris: MutableList<Uri!>
): Unit

Similar to setNotificationUri(android.content.ContentResolver,android.net.Uri), except this version allows to watch multiple content URIs for changes.

If this is not implemented, this is equivalent to calling setNotificationUri(android.content.ContentResolver,android.net.Uri) with the first URI in uris.

Calling this overrides any previous call to setNotificationUri(android.content.ContentResolver,android.net.Uri).

unregisterContentObserver

open fun unregisterContentObserver(observer: ContentObserver!): Unit

Unregister an observer that has previously been registered with this cursor via registerContentObserver.

unregisterDataSetObserver

open fun unregisterDataSetObserver(observer: DataSetObserver!): Unit

Unregister an observer that has previously been registered with this cursor via registerContentObserver.

checkPosition

protected open fun checkPosition(): Unit

This function throws CursorIndexOutOfBoundsException if the cursor position is out of bounds. Subclass implementations of the get functions should call this before attempting to retrieve data.

finalize

protected open fun finalize(): Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

getUpdatedField

protected open fun getUpdatedField(columnIndex: Int): Any!

Deprecated: Always returns null since Cursors do not support updating rows

isFieldUpdated

protected open fun isFieldUpdated(columnIndex: Int): Boolean

Deprecated: Always returns false since Cursors do not support updating rows

onChange

protected open fun onChange(selfChange: Boolean): Unit

Subclasses must call this method when they finish committing updates to notify all observers.

mClosed

protected var mClosed: Boolean

Deprecated: Use isClosed() instead.

mContentResolver

protected var mContentResolver: ContentResolver!

Deprecated: Do not use.

mPos

protected var mPos: Int

Deprecated: Use getPosition() instead.