CursorWrapper
open class CursorWrapper : Cursor
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
Public constructors
|
|
Creates a cursor wrapper.
|
Public constructors
<init>
CursorWrapper(cursor: Cursor!)
Creates a cursor wrapper.
| Parameters |
cursor |
Cursor!: The underlying cursor to wrap. |
Public methods
close
open fun close(): Unit
| Exceptions |
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
if an I/O error occurs |
copyStringToBuffer
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 |
buffer |
CharArrayBuffer!: the buffer to copy the text into. |
deactivate
open fun deactivate(): Unit
Deprecated.
getBlob
open fun getBlob(columnIndex: Int): ByteArray!
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
ByteArray! |
the value of that column as a byte array. |
getColumnCount
open fun getColumnCount(): Int
| Return |
Int |
number of columns |
getColumnIndex
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. |
getColumnIndexOrThrow
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 |
| Exceptions |
java.lang.IllegalArgumentException |
if the column does not exist |
getColumnName
open fun getColumnName(columnIndex: Int): String!
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
String! |
the column name for the given column index. |
getColumnNames
open fun getColumnNames(): Array<String!>!
| Return |
Array<String!>! |
the names of the columns returned in this query. |
getCount
open fun getCount(): Int
| Return |
Int |
the number of rows in the cursor. |
getDouble
open fun getDouble(columnIndex: Int): Double
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Double |
the value of that column as a double. |
getFloat
open fun getFloat(columnIndex: Int): Float
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Float |
the value of that column as a float. |
getInt
open fun getInt(columnIndex: Int): Int
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Int |
the value of that column as an int. |
getLong
open fun getLong(columnIndex: Int): Long
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Long |
the value of that column as a long. |
getNotificationUri
open fun getNotificationUri(): Uri!
getNotificationUris
open fun getNotificationUris(): MutableList<Uri!>?
getPosition
open fun getPosition(): Int
| Return |
Int |
the current cursor position. |
getShort
open fun getShort(columnIndex: Int): Short
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Short |
the value of that column as a short. |
getString
open fun getString(columnIndex: Int): String!
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
String! |
the value of that column as a String. |
getType
open fun getType(columnIndex: Int): Int
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Int |
column value type |
getWantsAllOnMoveCalls
open fun getWantsAllOnMoveCalls(): Boolean
| Return |
Boolean |
whether all cursor movement should result in a call to onMove(). |
getWrappedCursor
open fun getWrappedCursor(): Cursor!
Gets the underlying cursor that is wrapped by this instance.
| Return |
Cursor! |
The wrapped cursor. |
isAfterLast
open fun isAfterLast(): Boolean
| Return |
Boolean |
whether the cursor is after the last result. |
isBeforeFirst
open fun isBeforeFirst(): Boolean
| Return |
Boolean |
whether the cursor is before the first result. |
isClosed
open fun isClosed(): Boolean
| Return |
Boolean |
true if the cursor is closed. |
isFirst
open fun isFirst(): Boolean
| Return |
Boolean |
whether the cursor is pointing at the first entry. |
isLast
open fun isLast(): Boolean
| Return |
Boolean |
whether the cursor is pointing at the last entry. |
isNull
open fun isNull(columnIndex: Int): Boolean
| Parameters |
columnIndex |
Int: the zero-based index of the target column. |
| Return |
Boolean |
whether the column value is null. |
move
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
open fun moveToFirst(): Boolean
| Return |
Boolean |
whether the move succeeded. |
moveToLast
open fun moveToLast(): Boolean
| Return |
Boolean |
whether the move succeeded. |
moveToNext
open fun moveToNext(): Boolean
| Return |
Boolean |
whether the move succeeded. |
moveToPosition
open fun moveToPosition(position: Int): Boolean
| Parameters |
position |
Int: the zero-based position to move to. |
| Return |
Boolean |
whether the requested move fully succeeded. |
moveToPrevious
open fun moveToPrevious(): Boolean
| Return |
Boolean |
whether the move succeeded. |
registerContentObserver
open fun registerContentObserver(observer: ContentObserver!): Unit
| Parameters |
observer |
ContentObserver!: the object that gets notified when the content backing the cursor changes. |
registerDataSetObserver
open fun registerDataSetObserver(observer: DataSetObserver!): Unit
| Parameters |
observer |
DataSetObserver!: the object that gets notified when the cursors data set changes. |
requery
open fun requery(): Boolean
Deprecated.
| Return |
Boolean |
true if the requery succeeded, false if not, in which case the cursor becomes invalid. |
open fun setExtras(extras: Bundle!): Unit
| Parameters |
extras |
Bundle!: Bundle to set, or null to set an empty bundle. |
setNotificationUri
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
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. |
