Android APIs
public class

CrossProcessCursorWrapper

extends CursorWrapper
implements CrossProcessCursor
java.lang.Object
   ↳ android.database.CursorWrapper
     ↳ android.database.CrossProcessCursorWrapper

Class Overview

Cursor wrapper that implements CrossProcessCursor.

If the wrapped cursor implements CrossProcessCursor, then the wrapper delegates fillWindow(int, CursorWindow), getWindow() and onMove(int, int) to it. Otherwise, the wrapper provides default implementations of these methods that traverse the contents of the cursor similar to fillWindow(int, CursorWindow).

This wrapper can be used to adapt an ordinary Cursor into a CrossProcessCursor.

Summary

[Expand]
Inherited Constants
From interface android.database.Cursor
Public Constructors
CrossProcessCursorWrapper(Cursor cursor)
Creates a cross process cursor wrapper.
Public Methods
void fillWindow(int position, CursorWindow window)
Copies cursor data into the window.
CursorWindow getWindow()
Returns a pre-filled window that contains the data within this cursor.
boolean onMove(int oldPosition, int newPosition)
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.
[Expand]
Inherited Methods
From class android.database.CursorWrapper
From class java.lang.Object
From interface android.database.Cursor
From interface android.database.CrossProcessCursor
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public Constructors

public CrossProcessCursorWrapper (Cursor cursor)

Added in API level 15

Creates a cross process cursor wrapper.

Parameters
cursor The underlying cursor to wrap.

Public Methods

public void fillWindow (int position, CursorWindow window)

Added in API level 15

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.

Parameters
position The zero-based index of the first row to copy into the window.
window The window to fill.

public CursorWindow getWindow ()

Added in API level 15

Returns a pre-filled window that contains the data within this cursor.

In particular, the window contains the row indicated by getPosition(). The window's contents are automatically scrolled whenever the current row moved outside the range covered by the window.

Returns
CursorWindow The pre-filled window, or null if none.

public boolean onMove (int oldPosition, int newPosition)

Added in API level 15

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.

This function should be called by methods such as moveToPosition(int), so it will typically not be called from outside of the cursor class itself.

Parameters
oldPosition The position that we're moving from.
newPosition The position that we're moving to.
Returns
boolean True if the move is successful, false otherwise.