IT. Expert System.

Android Reference

CursorWrapper

android.database

Class CursorWrapper

java.lang.Object
- android.database.CursorWrapper

All Implemented Interfaces:

Cursor, Closeable, AutoCloseable

Direct Known Subclasses:

CrossProcessCursorWrapper
```
public class CursorWrapper
extends Object
implements 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.

Field Summary

Fields
Modifier and Type Field and Description

protected Cursor mCursor
- Fields inherited from interface android.database.Cursor
  FIELD_TYPE_BLOB, FIELD_TYPE_FLOAT, FIELD_TYPE_INTEGER, FIELD_TYPE_NULL, FIELD_TYPE_STRING

Fields
Modifier and Type	Field and Description
`protected Cursor`	`mCursor`

Constructor Summary

Constructors
Constructor and Description

CursorWrapper(Cursor cursor)
Creates a cursor wrapper.

Constructors
Constructor and Description
`CursorWrapper(Cursor cursor)` Creates a cursor wrapper.

Method Summary

Methods
Modifier and Type	Method and Description
`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 `Cursor.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.
`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 `Cursor.requery()`, `Cursor.deactivate()`, or `Cursor.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 `Cursor.registerContentObserver(android.database.ContentObserver)`.
`void`	`unregisterDataSetObserver(DataSetObserver observer)` Unregister an observer that has previously been registered with this cursor via `Cursor.registerContentObserver(android.database.ContentObserver)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mCursor
```
protected final Cursor mCursor
```
- Constructor Detail
  - CursorWrapper
```
public CursorWrapper(Cursor cursor)
```
    Creates a cursor wrapper.
    
    Parameters:
    cursor - The underlying cursor to wrap.
- Method Detail
  - getWrappedCursor
```
public Cursor getWrappedCursor()
```
    Gets the underlying cursor that is wrapped by this instance.
    
    Returns:
    The wrapped cursor.
  - close
```
public void close()
```
    Description copied from interface: Cursor
    
    Closes the Cursor, releasing all of its resources and making it completely invalid. Unlike Cursor.deactivate() a call to Cursor.requery() will not make the Cursor valid again.
    
    Specified by:
    
    close in interface Cursor
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: Cursor
    
    return true if the cursor is closed
    
    Specified by:
    
    isClosed in interface Cursor
    
    Returns:
    true if the cursor is closed.
  - getCount
```
public int getCount()
```
    Description copied from interface: Cursor
    
    Returns the numbers of rows in the cursor.
    
    Specified by:
    
    getCount in interface Cursor
    
    Returns:
    the number of rows in the cursor.
  - deactivate
```
public void deactivate()
```
    Description copied from interface: Cursor
    
    Deactivates the Cursor, making all calls on it fail until Cursor.requery() is called. Inactive Cursors use fewer resources than active Cursors. Calling Cursor.requery() will make the cursor active again.
    
    Specified by:
    
    deactivate in interface Cursor
  - moveToFirst
```
public boolean moveToFirst()
```
    Description copied from interface: Cursor
    
    Move the cursor to the first row.
    This method will return false if the cursor is empty.
    
    Specified by:
    
    moveToFirst in interface Cursor
    
    Returns:
    whether the move succeeded.
  - getColumnCount
```
public int getColumnCount()
```
    Description copied from interface: Cursor
    
    Return total number of columns
    
    Specified by:
    
    getColumnCount in interface Cursor
    
    Returns:
    number of columns
  - getColumnIndex
```
public int getColumnIndex(String columnName)
```
    Description copied from interface: Cursor
    
    Returns the zero-based index for the given column name, or -1 if the column doesn't exist. If you expect the column to exist use Cursor.getColumnIndexOrThrow(String) instead, which will make the error more clear.
    
    Specified by:
    
    getColumnIndex in interface Cursor
    
    Parameters:
    columnName - the name of the target column.
    
    Returns:
    the zero-based column index for the given column name, or -1 if the column name does not exist.
    See Also:
    Cursor.getColumnIndexOrThrow(String)
  - getColumnIndexOrThrow
```
public int getColumnIndexOrThrow(String columnName)
                          throws IllegalArgumentException
```
    Description copied from interface: Cursor
    
    Returns the zero-based index for the given column name, or throws IllegalArgumentException if the column doesn't exist. If you're not sure if a column will exist or not use Cursor.getColumnIndex(String) and check for -1, which is more efficient than catching the exceptions.
    
    Specified by:
    
    getColumnIndexOrThrow in interface Cursor
    
    Parameters:
    columnName - the name of the target column.
    
    Returns:
    the zero-based column index for the given column name
    
    Throws:
    
    IllegalArgumentException - if the column does not exist
    See Also:
    Cursor.getColumnIndex(String)
  - getColumnName
```
public String getColumnName(int columnIndex)
```
    Description copied from interface: Cursor
    
    Returns the column name at the given zero-based column index.
    
    Specified by:
    
    getColumnName in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the column name for the given column index.
  - getColumnNames
```
public String[] getColumnNames()
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getColumnNames in interface Cursor
    
    Returns:
    the names of the columns returned in this query.
  - getDouble
```
public double getDouble(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getDouble in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a double.
  - getExtras
```
public Bundle getExtras()
```
    Description copied from interface: Cursor
    
    Returns a bundle of extra values. This is an optional way for cursors to provide out-of-band metadata to their users. One use of this is for reporting on the progress of network requests that are required to fetch data for the cursor.
    These values may only change when requery is called.
    
    Specified by:
    
    getExtras in interface Cursor
    
    Returns:
    cursor-defined values, or Bundle.EMPTY if there are no values. Never null.
  - getFloat
```
public float getFloat(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getFloat in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a float.
  - getInt
```
public int getInt(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getInt in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as an int.
  - getLong
```
public long getLong(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getLong in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a long.
  - getShort
```
public short getShort(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getShort in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a short.
  - getString
```
public String getString(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getString in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a String.
  - copyStringToBuffer
```
public void copyStringToBuffer(int columnIndex,
                      CharArrayBuffer buffer)
```
    Description copied from interface: Cursor
    
    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
    
    Specified by:
    
    copyStringToBuffer in interface Cursor
    
    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.
  - getBlob
```
public byte[] getBlob(int columnIndex)
```
    Description copied from interface: Cursor
    
    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.
    
    Specified by:
    
    getBlob in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    the value of that column as a byte array.
  - getWantsAllOnMoveCalls
```
public boolean getWantsAllOnMoveCalls()
```
    Description copied from interface: Cursor
    
    onMove() will only be called across processes if this method returns true.
    
    Specified by:
    
    getWantsAllOnMoveCalls in interface Cursor
    
    Returns:
    whether all cursor movement should result in a call to onMove().
  - isAfterLast
```
public boolean isAfterLast()
```
    Description copied from interface: Cursor
    
    Returns whether the cursor is pointing to the position after the last row.
    
    Specified by:
    
    isAfterLast in interface Cursor
    
    Returns:
    whether the cursor is after the last result.
  - isBeforeFirst
```
public boolean isBeforeFirst()
```
    Description copied from interface: Cursor
    
    Returns whether the cursor is pointing to the position before the first row.
    
    Specified by:
    
    isBeforeFirst in interface Cursor
    
    Returns:
    whether the cursor is before the first result.
  - isFirst
```
public boolean isFirst()
```
    Description copied from interface: Cursor
    
    Returns whether the cursor is pointing to the first row.
    
    Specified by:
    
    isFirst in interface Cursor
    
    Returns:
    whether the cursor is pointing at the first entry.
  - isLast
```
public boolean isLast()
```
    Description copied from interface: Cursor
    
    Returns whether the cursor is pointing to the last row.
    
    Specified by:
    
    isLast in interface Cursor
    
    Returns:
    whether the cursor is pointing at the last entry.
  - getType
```
public int getType(int columnIndex)
```
    Description copied from interface: Cursor
    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 Cursor.getInt(int), Cursor.getFloat(int) etc.
    Returned column types are
    Specified by:
    
    getType in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    column value type
  - isNull
```
public boolean isNull(int columnIndex)
```
    Description copied from interface: Cursor
    
    Returns true if the value in the indicated column is null.
    
    Specified by:
    
    isNull in interface Cursor
    
    Parameters:
    columnIndex - the zero-based index of the target column.
    
    Returns:
    whether the column value is null.
  - moveToLast
```
public boolean moveToLast()
```
    Description copied from interface: Cursor
    
    Move the cursor to the last row.
    This method will return false if the cursor is empty.
    
    Specified by:
    
    moveToLast in interface Cursor
    
    Returns:
    whether the move succeeded.
  - move
```
public boolean move(int offset)
```
    Description copied from interface: Cursor
    
    Move the cursor by a relative amount, forward or backward, from the current position. Positive offsets move forwards, negative offsets move backwards. If the final position is outside of the bounds of the result set then the resultant position will be pinned to -1 or count() depending on whether the value is off the front or end of the set, respectively.
    This method will return true if the requested destination was reachable, otherwise, it returns false. For example, if the cursor is at currently on the second entry in the result set and move(-5) is called, the position will be pinned at -1, and false will be returned.
    
    Specified by:
    
    move in interface Cursor
    
    Parameters:
    offset - the offset to be applied from the current position.
    
    Returns:
    whether the requested move fully succeeded.
  - moveToPosition
```
public boolean moveToPosition(int position)
```
    Description copied from interface: Cursor
    
    Move the cursor to an absolute position. The valid range of values is -1 <= position <= count.
    This method will return true if the request destination was reachable, otherwise, it returns false.
    
    Specified by:
    
    moveToPosition in interface Cursor
    
    Parameters:
    position - the zero-based position to move to.
    
    Returns:
    whether the requested move fully succeeded.
  - moveToNext
```
public boolean moveToNext()
```
    Description copied from interface: Cursor
    
    Move the cursor to the next row.
    This method will return false if the cursor is already past the last entry in the result set.
    
    Specified by:
    
    moveToNext in interface Cursor
    
    Returns:
    whether the move succeeded.
  - getPosition
```
public int getPosition()
```
    Description copied from interface: Cursor
    
    Returns the current position of the cursor in the row set. The value is zero-based. When the row set is first returned the cursor will be at positon -1, which is before the first row. After the last row is returned another call to next() will leave the cursor past the last entry, at a position of count().
    
    Specified by:
    
    getPosition in interface Cursor
    
    Returns:
    the current cursor position.
  - moveToPrevious
```
public boolean moveToPrevious()
```
    Description copied from interface: Cursor
    
    Move the cursor to the previous row.
    This method will return false if the cursor is already before the first entry in the result set.
    
    Specified by:
    
    moveToPrevious in interface Cursor
    
    Returns:
    whether the move succeeded.
  - registerContentObserver
```
public void registerContentObserver(ContentObserver observer)
```
    Description copied from interface: Cursor
    
    Register an observer that is called when changes happen to the content backing this cursor. Typically the data set won't change until Cursor.requery() is called.
    
    Specified by:
    
    registerContentObserver in interface Cursor
    
    Parameters:
    observer - the object that gets notified when the content backing the cursor changes.
    See Also:
    Cursor.unregisterContentObserver(ContentObserver)
  - registerDataSetObserver
```
public void registerDataSetObserver(DataSetObserver observer)
```
    Description copied from interface: Cursor
    
    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 Cursor.requery(), Cursor.deactivate(), or Cursor.close().
    
    Specified by:
    
    registerDataSetObserver in interface Cursor
    
    Parameters:
    observer - the object that gets notified when the cursors data set changes.
    See Also:
    Cursor.unregisterDataSetObserver(DataSetObserver)
  - requery
```
public boolean requery()
```
    Description copied from interface: Cursor
    
    Performs the query that created the cursor again, refreshing its contents. This may be done at any time, including after a call to Cursor.deactivate(). Since this method could execute a query on the database and potentially take a while, it could cause ANR if it is called on Main (UI) thread. A warning is printed if this method is being executed on Main thread.
    
    Specified by:
    
    requery in interface Cursor
    
    Returns:
    true if the requery succeeded, false if not, in which case the cursor becomes invalid.
  - respond
```
public Bundle respond(Bundle extras)
```
    Description copied from interface: Cursor
    
    This is an out-of-band way for the the user of a cursor to communicate with the cursor. The structure of each bundle is entirely defined by the cursor.
    One use of this is to tell a cursor that it should retry its network request after it reported an error.
    
    Specified by:
    
    respond in interface Cursor
    
    Parameters:
    extras - extra values, or Bundle.EMPTY. Never null.
    
    Returns:
    extra values, or Bundle.EMPTY. Never null.
  - setNotificationUri
```
public void setNotificationUri(ContentResolver cr,
                      Uri uri)
```
    Description copied from interface: Cursor
    
    Register to watch a content URI for changes. This can be the URI of a specific data row (for example, "content://my_provider_type/23"), or a a generic URI for a content type.
    
    Specified by:
    
    setNotificationUri in interface Cursor
    
    Parameters:
    cr - The content resolver from the caller's context. The listener attached to this resolver will be notified.
    uri - The content URI to watch.
  - unregisterContentObserver
```
public void unregisterContentObserver(ContentObserver observer)
```
    Description copied from interface: Cursor
    
    Unregister an observer that has previously been registered with this cursor via Cursor.registerContentObserver(android.database.ContentObserver).
    
    Specified by:
    
    unregisterContentObserver in interface Cursor
    
    Parameters:
    observer - the object to unregister.
    See Also:
    Cursor.registerContentObserver(ContentObserver)
  - unregisterDataSetObserver
```
public void unregisterDataSetObserver(DataSetObserver observer)
```
    Description copied from interface: Cursor
    
    Unregister an observer that has previously been registered with this cursor via Cursor.registerContentObserver(android.database.ContentObserver).
    
    Specified by:
    
    unregisterDataSetObserver in interface Cursor
    
    Parameters:
    observer - the object to unregister.
    See Also:
    Cursor.registerDataSetObserver(DataSetObserver)

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

CursorWrapper

Class CursorWrapper

Field Summary

Fields inherited from interface android.database.Cursor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mCursor

Constructor Detail

CursorWrapper

Method Detail

getWrappedCursor

close

isClosed

getCount

deactivate

moveToFirst

getColumnCount

getColumnIndex

getColumnIndexOrThrow

getColumnName

getColumnNames

getDouble

getExtras

getFloat

getInt

getLong

getShort

getString

copyStringToBuffer

getBlob

getWantsAllOnMoveCalls

isAfterLast

isBeforeFirst

isFirst

isLast

getType

isNull

moveToLast

move

moveToPosition

moveToNext

getPosition

moveToPrevious

registerContentObserver

registerDataSetObserver

requery

respond

setNotificationUri

unregisterContentObserver

unregisterDataSetObserver

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary