Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 15

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

void	close () Closes the Cursor, releasing all of its resources and making it completely invalid.
void	copyStringToBuffer (int columnIndex, CharArrayBuffer buffer) Retrieves the requested column text and stores it in the buffer provided.
void	deactivate () Deactivates the Cursor, making all calls on it fail until `requery()` is called.
byte[]	getBlob (int columnIndex) Returns the value of the requested column as a byte array.
int	getColumnCount () Return total number of columns
int	getColumnIndex ( String columnName) Returns the zero-based index for the given column name, or -1 if the column doesn't exist.
int	getColumnIndexOrThrow ( String columnName) Returns the zero-based index for the given column name, or throws `IllegalArgumentException` if the column doesn't exist.
String	getColumnName (int columnIndex) Returns the column name at the given zero-based column index.
String[]	getColumnNames () 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.
int	getCount () Returns the numbers of rows in the cursor.
double	getDouble (int columnIndex) Returns the value of the requested column as a double.
Bundle	getExtras () Returns a bundle of extra values.
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.
Uri	getNotificationUri () Return the URI at which notifications of changes in this Cursor's data will be delivered, as previously set by `setNotificationUri(ContentResolver, Uri)` .
int	getPosition () Returns the current position of the cursor in the row set.
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.
boolean	getWantsAllOnMoveCalls () onMove() will only be called across processes if this method returns true.
Cursor	getWrappedCursor () Gets the underlying cursor that is wrapped by this instance.
boolean	isAfterLast () Returns whether the cursor is pointing to the position after the last row.
boolean	isBeforeFirst () Returns whether the cursor is pointing to the position before the first row.
boolean	isClosed () return true if the cursor is closed
boolean	isFirst () Returns whether the cursor is pointing to the first row.
boolean	isLast () Returns whether the cursor is pointing to the last row.
boolean	isNull (int columnIndex) Returns `true` if the value in the indicated column is null.
boolean	move (int offset) Move the cursor by a relative amount, forward or backward, from the current position.
boolean	moveToFirst () Move the cursor to the first row.
boolean	moveToLast () Move the cursor to the last row.
boolean	moveToNext () Move the cursor to the next row.
boolean	moveToPosition (int position) Move the cursor to an absolute position.
boolean	moveToPrevious () Move the cursor to the previous row.
void	registerContentObserver ( ContentObserver observer) Register an observer that is called when changes happen to the content backing this cursor.
void	registerDataSetObserver ( DataSetObserver observer) 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()` .
boolean	requery () Performs the query that created the cursor again, refreshing its contents.
Bundle	respond ( Bundle extras) This is an out-of-band way for the the user of a cursor to communicate with the cursor.
void	setNotificationUri ( ContentResolver cr, Uri uri) Register to watch a content URI for changes.
void	unregisterContentObserver ( ContentObserver observer) Unregister an observer that has previously been registered with this cursor via `registerContentObserver(ContentObserver)` .
void	unregisterDataSetObserver ( DataSetObserver observer) Unregister an observer that has previously been registered with this cursor via `registerContentObserver(ContentObserver)` .

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.database.CrossProcessCursor

From interface android.database.Cursor

abstract void	close () Closes the Cursor, releasing all of its resources and making it completely invalid.
abstract void	copyStringToBuffer (int columnIndex, CharArrayBuffer buffer) Retrieves the requested column text and stores it in the buffer provided.
abstract void	deactivate () This method was deprecated in API level 16. Since `requery()` is deprecated, so too is this.
abstract byte[]	getBlob (int columnIndex) Returns the value of the requested column as a byte array.
abstract int	getColumnCount () Return total number of columns
abstract int	getColumnIndex ( String columnName) Returns the zero-based index for the given column name, or -1 if the column doesn't exist.
abstract int	getColumnIndexOrThrow ( String columnName) Returns the zero-based index for the given column name, or throws `IllegalArgumentException` if the column doesn't exist.
abstract String	getColumnName (int columnIndex) Returns the column name at the given zero-based column index.
abstract String[]	getColumnNames () 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.
abstract int	getCount () Returns the numbers of rows in the cursor.
abstract double	getDouble (int columnIndex) Returns the value of the requested column as a double.
abstract Bundle	getExtras () Returns a bundle of extra values.
abstract float	getFloat (int columnIndex) Returns the value of the requested column as a float.
abstract int	getInt (int columnIndex) Returns the value of the requested column as an int.
abstract long	getLong (int columnIndex) Returns the value of the requested column as a long.
abstract Uri	getNotificationUri () Return the URI at which notifications of changes in this Cursor's data will be delivered, as previously set by `setNotificationUri(ContentResolver, Uri)` .
abstract int	getPosition () Returns the current position of the cursor in the row set.
abstract short	getShort (int columnIndex) Returns the value of the requested column as a short.
abstract String	getString (int columnIndex) Returns the value of the requested column as a String.
abstract int	getType (int columnIndex) Returns data type of the given column's value.
abstract boolean	getWantsAllOnMoveCalls () onMove() will only be called across processes if this method returns true.
abstract boolean	isAfterLast () Returns whether the cursor is pointing to the position after the last row.
abstract boolean	isBeforeFirst () Returns whether the cursor is pointing to the position before the first row.
abstract boolean	isClosed () return true if the cursor is closed
abstract boolean	isFirst () Returns whether the cursor is pointing to the first row.
abstract boolean	isLast () Returns whether the cursor is pointing to the last row.
abstract boolean	isNull (int columnIndex) Returns `true` if the value in the indicated column is null.
abstract boolean	move (int offset) Move the cursor by a relative amount, forward or backward, from the current position.
abstract boolean	moveToFirst () Move the cursor to the first row.
abstract boolean	moveToLast () Move the cursor to the last row.
abstract boolean	moveToNext () Move the cursor to the next row.
abstract boolean	moveToPosition (int position) Move the cursor to an absolute position.
abstract boolean	moveToPrevious () Move the cursor to the previous row.
abstract void	registerContentObserver ( ContentObserver observer) Register an observer that is called when changes happen to the content backing this cursor.
abstract void	registerDataSetObserver ( DataSetObserver observer) 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()` .
abstract boolean	requery () This method was deprecated in API level 11. Don't use this. Just request a new cursor, so you can do this asynchronously and update your list view once the new cursor comes back.
abstract Bundle	respond ( Bundle extras) This is an out-of-band way for the the user of a cursor to communicate with the cursor.
abstract void	setNotificationUri ( ContentResolver cr, Uri uri) Register to watch a content URI for changes.
abstract void	unregisterContentObserver ( ContentObserver observer) Unregister an observer that has previously been registered with this cursor via `registerContentObserver(ContentObserver)` .
abstract void	unregisterDataSetObserver ( DataSetObserver observer) Unregister an observer that has previously been registered with this cursor via `registerContentObserver(ContentObserver)` .

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

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

True if the move is successful, false otherwise.

Results

Interfaces

Classes

Enums

Exceptions

CrossProcessCursorWrapper

Class Overview

Summary

Public Constructors

public CrossProcessCursorWrapper ( Cursor cursor)

Parameters

Public Methods

public void fillWindow (int position, CursorWindow window)

Parameters

public CursorWindow getWindow ()

Returns

public boolean onMove (int oldPosition, int newPosition)

Parameters

Returns