CursorWindow

CursorWindow

CursorWindow(localWindow: Boolean)

Deprecated: There is no longer a distinction between local and remote cursor windows. Use the CursorWindow(java.lang.String) constructor instead.

Creates a new empty cursor window.

The cursor initially has no rows or columns. Call setNumColumns(int) to set the number of columns before adding any rows to the cursor.

CursorWindow

CursorWindow(name: String!)

Creates a new empty cursor window and gives it a name.

The cursor initially has no rows or columns. Call setNumColumns(int) to set the number of columns before adding any rows to the cursor.

CursorWindow

CursorWindow(
    name: String!, 
    windowSizeBytes: Long)

Creates a new empty cursor window and gives it a name.

The cursor initially has no rows or columns. Call setNumColumns(int) to set the number of columns before adding any rows to the cursor.

allocRow

open fun allocRow(): Boolean

Allocates a new row at the end of this cursor window.

clear

open fun clear(): Unit

Clears out the existing contents of the window, making it safe to reuse for new data.

The start position (getStartPosition()), number of rows (getNumRows()), and number of columns in the cursor are all reset to zero.

copyStringToBuffer

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

Copies the text of the field at the specified row and column index into a CharArrayBuffer.

The buffer is populated as follows:

• If the buffer is too small for the value to be copied, then it is automatically resized.
• If the field is of type Cursor.FIELD_TYPE_NULL, then the buffer is set to an empty string.
• If the field is of type Cursor.FIELD_TYPE_STRING, then the buffer is set to the contents of the string.
• If the field is of type Cursor.FIELD_TYPE_INTEGER, then the buffer is set to a string representation of the integer in decimal, obtained by formatting the value with the printf family of functions using format specifier %lld.
• If the field is of type Cursor.FIELD_TYPE_FLOAT, then the buffer is set to a string representation of the floating-point value in decimal, obtained by formatting the value with the printf family of functions using format specifier %g.
• If the field is of type Cursor.FIELD_TYPE_BLOB, then a SQLiteException is thrown.

describeContents

open fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

freeLastRow

open fun freeLastRow(): Unit

Frees the last row in this cursor window.

getBlob

open fun getBlob(
    row: Int, 
    column: Int
): ByteArray!

Gets the value of the field at the specified row and column index as a byte array.

The result is determined as follows:

• If the field is of type Cursor.FIELD_TYPE_NULL, then the result is null.
• If the field is of type Cursor.FIELD_TYPE_BLOB, then the result is the blob value.
• If the field is of type Cursor.FIELD_TYPE_STRING, then the result is the array of bytes that make up the internal representation of the string value.
• If the field is of type Cursor.FIELD_TYPE_INTEGER or Cursor.FIELD_TYPE_FLOAT, then a SQLiteException is thrown.

getDouble

open fun getDouble(
    row: Int, 
    column: Int
): Double

Gets the value of the field at the specified row and column index as a double.

The result is determined as follows:

• If the field is of type Cursor.FIELD_TYPE_NULL, then the result is 0.0.
• If the field is of type Cursor.FIELD_TYPE_STRING, then the result is the value obtained by parsing the string value with strtod.
• If the field is of type Cursor.FIELD_TYPE_INTEGER, then the result is the integer value converted to a double.
• If the field is of type Cursor.FIELD_TYPE_FLOAT, then the result is the double value.
• If the field is of type Cursor.FIELD_TYPE_BLOB, then a SQLiteException is thrown.

getFloat

open fun getFloat(
    row: Int, 
    column: Int
): Float

Gets the value of the field at the specified row and column index as a float.

The result is determined by invoking getDouble and converting the result to float.

getInt

open fun getInt(
    row: Int, 
    column: Int
): Int

Gets the value of the field at the specified row and column index as an int.

The result is determined by invoking getLong and converting the result to int.

getLong

open fun getLong(
    row: Int, 
    column: Int
): Long

Gets the value of the field at the specified row and column index as a long.

The result is determined as follows:

• If the field is of type Cursor.FIELD_TYPE_NULL, then the result is 0L.
• If the field is of type Cursor.FIELD_TYPE_STRING, then the result is the value obtained by parsing the string value with strtoll.
• If the field is of type Cursor.FIELD_TYPE_INTEGER, then the result is the long value.
• If the field is of type Cursor.FIELD_TYPE_FLOAT, then the result is the floating-point value converted to a long.
• If the field is of type Cursor.FIELD_TYPE_BLOB, then a SQLiteException is thrown.

getNumRows

open fun getNumRows(): Int

Gets the number of rows in this window.

getShort

open fun getShort(
    row: Int, 
    column: Int
): Short

Gets the value of the field at the specified row and column index as a short.

The result is determined by invoking getLong and converting the result to short.

getStartPosition

open fun getStartPosition(): Int

Gets the start position of this cursor window.

The start position is the zero-based index of the first row that this window contains relative to the entire result set of the Cursor.

getString

open fun getString(
    row: Int, 
    column: Int
): String!

Gets the value of the field at the specified row and column index as a string.

The result is determined as follows:

• If the field is of type Cursor.FIELD_TYPE_NULL, then the result is null.
• If the field is of type Cursor.FIELD_TYPE_STRING, then the result is the string value.
• If the field is of type Cursor.FIELD_TYPE_INTEGER, then the result is a string representation of the integer in decimal, obtained by formatting the value with the printf family of functions using format specifier %lld.
• If the field is of type Cursor.FIELD_TYPE_FLOAT, then the result is a string representation of the floating-point value in decimal, obtained by formatting the value with the printf family of functions using format specifier %g.
• If the field is of type Cursor.FIELD_TYPE_BLOB, then a SQLiteException is thrown.

getType

open fun getType(
    row: Int, 
    column: Int
): Int

Returns the type of the field at the specified row and column index.

isBlob

open fun isBlob(
    row: Int, 
    column: Int
): Boolean

Deprecated: Use getType(int,int) instead.

Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_BLOB or Cursor.FIELD_TYPE_NULL.

isFloat

open fun isFloat(
    row: Int, 
    column: Int
): Boolean

Deprecated: Use getType(int,int) instead.

Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_FLOAT.

isLong

open fun isLong(
    row: Int, 
    column: Int
): Boolean

Deprecated: Use getType(int,int) instead.

Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_INTEGER.

isNull

open fun isNull(
    row: Int, 
    column: Int
): Boolean

Deprecated: Use getType(int,int) instead.

Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_NULL.

isString

open fun isString(
    row: Int, 
    column: Int
): Boolean

Deprecated: Use getType(int,int) instead.

Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_STRING or Cursor.FIELD_TYPE_NULL.

newFromParcel

open static fun newFromParcel(p: Parcel!): CursorWindow!

putBlob

open fun putBlob(
    value: ByteArray!, 
    row: Int, 
    column: Int
): Boolean

Copies a byte array into the field at the specified row and column index.

putDouble

open fun putDouble(
    value: Double, 
    row: Int, 
    column: Int
): Boolean

Puts a double-precision floating point value into the field at the specified row and column index.

putLong

open fun putLong(
    value: Long, 
    row: Int, 
    column: Int
): Boolean

Puts a long integer into the field at the specified row and column index.

putNull

open fun putNull(
    row: Int, 
    column: Int
): Boolean

Puts a null value into the field at the specified row and column index.

putString

open fun putString(
    value: String!, 
    row: Int, 
    column: Int
): Boolean

Copies a string into the field at the specified row and column index.

setNumColumns

open fun setNumColumns(columnNum: Int): Boolean

Sets the number of columns in this window.

This method must be called before any rows are added to the window, otherwise it will fail to set the number of columns if it differs from the current number of columns.

setStartPosition

open fun setStartPosition(pos: Int): Unit

Sets the start position of this cursor window.

The start position is the zero-based index of the first row that this window contains relative to the entire result set of the Cursor.

toString

open fun toString(): String

Returns a string representation of the object.

writeToParcel

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

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.

onAllReferencesReleased

protected open fun onAllReferencesReleased(): Unit

Called when the last reference to the object was released by a call to releaseReference() or #close().

CREATOR

static val CREATOR: Parcelable.Creator<CursorWindow!>