Android APIs
public abstract class

AbstractWindowedCursor

extends AbstractCursor
java.lang.Object
   ↳ android.database.AbstractCursor
     ↳ android.database.AbstractWindowedCursor
Known Direct Subclasses

Class Overview

A base class for Cursors that store their data in CursorWindows.

The cursor owns the cursor window it uses. When the cursor is closed, its window is also closed. Likewise, when the window used by the cursor is changed, its old window is closed. This policy of strict ownership ensures that cursor windows are not leaked.

Subclasses are responsible for filling the cursor window with data during onMove(int, int), allocating a new cursor window if necessary. During requery(), the existing cursor window should be cleared and filled with new data.

If the contents of the cursor change or become invalid, the old window must be closed (because it is owned by the cursor) and set to null.

Summary

[Expand]
Inherited Constants
From interface android.database.Cursor
Fields
protected CursorWindow mWindow The cursor window owned by this cursor.
[Expand]
Inherited Fields
From class android.database.AbstractCursor
Public Constructors
AbstractWindowedCursor()
Public Methods
void copyStringToBuffer(int columnIndex, CharArrayBuffer buffer)
Retrieves the requested column text and stores it in the buffer provided.
byte[] getBlob(int columnIndex)
Returns the value of the requested column as a byte array.
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.
short getShort(int columnIndex)
Returns the value of the requested column as a short.
String getString(int columnIndex)
Returns the value of the requested column as a String.
int getType(int columnIndex)
Returns data type of the given column's value.
CursorWindow getWindow()
If the cursor is backed by a CursorWindow, returns a pre-filled window with the contents of the cursor, otherwise null.
boolean hasWindow()
Returns true if the cursor has an associated cursor window.
boolean isBlob(int columnIndex)
boolean isFloat(int columnIndex)
boolean isLong(int columnIndex)
boolean isNull(int columnIndex)
Returns true if the value in the indicated column is null.
boolean isString(int columnIndex)
void setWindow(CursorWindow window)
Sets a new cursor window for the cursor to use.
Protected Methods
void checkPosition()
This function throws CursorIndexOutOfBoundsException if the cursor position is out of bounds.
[Expand]
Inherited Methods
From class android.database.AbstractCursor
From class java.lang.Object
From interface android.database.CrossProcessCursor
From interface android.database.Cursor
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Fields

protected CursorWindow mWindow

Added in API level 1

The cursor window owned by this cursor.

Public Constructors

public AbstractWindowedCursor ()

Added in API level 1

Public Methods

public void copyStringToBuffer (int columnIndex, CharArrayBuffer buffer)

Added in API level 1

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

Parameters
columnIndex the zero-based index of the target column. if the target column is null, return buffer
buffer the buffer to copy the text into.

public byte[] getBlob (int columnIndex)

Added in API level 1

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.

public double getDouble (int columnIndex)

Added in API level 1

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.

public float getFloat (int columnIndex)

Added in API level 1

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.

public int getInt (int columnIndex)

Added in API level 1

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.

public long getLong (int columnIndex)

Added in API level 1

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.

public short getShort (int columnIndex)

Added in API level 1

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.

public String getString (int columnIndex)

Added in API level 1

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.

public int getType (int columnIndex)

Added in API level 11

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.

Returned column types are

Parameters
columnIndex the zero-based index of the target column.
Returns
  • column value type

public CursorWindow getWindow ()

Added in API level 1

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

Returns
  • The pre-filled window that backs this cursor, or null if none.

public boolean hasWindow ()

Added in API level 1

Returns true if the cursor has an associated cursor window.

Returns
  • True if the cursor has an associated cursor window.

public boolean isBlob (int columnIndex)

Added in API level 1

This method was deprecated in API level 11.
Use getType(int)

public boolean isFloat (int columnIndex)

Added in API level 5

This method was deprecated in API level 11.
Use getType(int)

public boolean isLong (int columnIndex)

Added in API level 5

This method was deprecated in API level 11.
Use getType(int)

public boolean isNull (int columnIndex)

Added in API level 1

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.

public boolean isString (int columnIndex)

Added in API level 5

This method was deprecated in API level 11.
Use getType(int)

public void setWindow (CursorWindow window)

Added in API level 1

Sets a new cursor window for the cursor to use.

The cursor takes ownership of the provided cursor window; the cursor window will be closed when the cursor is closed or when the cursor adopts a new cursor window.

If the cursor previously had a cursor window, then it is closed when the new cursor window is assigned.

Parameters
window The new cursor window, typically a remote cursor window.

Protected Methods

protected void checkPosition ()

Added in API level 1

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.