IT. Expert System.

Android Reference

CursorWindow

android.database

Class CursorWindow

java.lang.Object
- android.database.sqlite.SQLiteClosable
- - android.database.CursorWindow

All Implemented Interfaces:

Parcelable, Closeable, AutoCloseable
```
public class CursorWindow
extends SQLiteClosable
implements Parcelable
```
A buffer containing multiple cursor rows.
A CursorWindow is read-write when initially created and used locally. When sent to a remote process (by writing it to a Parcel), the remote process receives a read-only view of the cursor window. Typically the cursor window will be allocated by the producer, filled with data, and then sent to the consumer for reading.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<CursorWindow> CREATOR

int mWindowPtr
The native CursorWindow object pointer.
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<CursorWindow>`	`CREATOR`
`int`	`mWindowPtr` The native CursorWindow object pointer.

Constructor Summary

Constructors
Constructor and Description
`CursorWindow(boolean localWindow)` Deprecated. There is no longer a distinction between local and remote cursor windows. Use the `CursorWindow(String)` constructor instead.
`CursorWindow(String name)` Creates a new empty cursor window and gives it a name.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allocRow()` Allocates a new row at the end of this cursor window.
`void`	`clear()` Clears out the existing contents of the window, making it safe to reuse for new data.
`void`	`copyStringToBuffer(int row, int column, CharArrayBuffer buffer)` Copies the text of the field at the specified row and column index into a `CharArrayBuffer`.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable's marshalled representation.
`protected void`	`finalize()` Invoked when the garbage collector has detected that this instance is no longer reachable.
`void`	`freeLastRow()` Frees the last row in this cursor window.
`byte[]`	`getBlob(int row, int column)` Gets the value of the field at the specified row and column index as a byte array.
`double`	`getDouble(int row, int column)` Gets the value of the field at the specified row and column index as a `double`.
`float`	`getFloat(int row, int column)` Gets the value of the field at the specified row and column index as a `float`.
`int`	`getInt(int row, int column)` Gets the value of the field at the specified row and column index as an `int`.
`long`	`getLong(int row, int column)` Gets the value of the field at the specified row and column index as a `long`.
`String`	`getName()` Gets the name of this cursor window, never null.
`int`	`getNumRows()` Gets the number of rows in this window.
`short`	`getShort(int row, int column)` Gets the value of the field at the specified row and column index as a `short`.
`int`	`getStartPosition()` Gets the start position of this cursor window.
`String`	`getString(int row, int column)` Gets the value of the field at the specified row and column index as a string.
`int`	`getType(int row, int column)` Returns the type of the field at the specified row and column index.
`boolean`	`isBlob(int row, int column)` Deprecated. Use `getType(int, int)` instead.
`boolean`	`isFloat(int row, int column)` Deprecated. Use `getType(int, int)` instead.
`boolean`	`isLong(int row, int column)` Deprecated. Use `getType(int, int)` instead.
`boolean`	`isNull(int row, int column)` Deprecated. Use `getType(int, int)` instead.
`boolean`	`isString(int row, int column)` Deprecated. Use `getType(int, int)` instead.
`static CursorWindow`	`newFromParcel(Parcel p)`
`protected void`	`onAllReferencesReleased()` Called when the last reference to the object was released by a call to `SQLiteClosable.releaseReference()` or `SQLiteClosable.close()`.
`boolean`	`putBlob(byte[] value, int row, int column)` Copies a byte array into the field at the specified row and column index.
`boolean`	`putDouble(double value, int row, int column)` Puts a double-precision floating point value into the field at the specified row and column index.
`boolean`	`putLong(long value, int row, int column)` Puts a long integer into the field at the specified row and column index.
`boolean`	`putNull(int row, int column)` Puts a null value into the field at the specified row and column index.
`boolean`	`putString(String value, int row, int column)` Copies a string into the field at the specified row and column index.
`boolean`	`setNumColumns(int columnNum)` Sets the number of columns in this window.
`void`	`setStartPosition(int pos)` Sets the start position of this cursor window.
`String`	`toString()` Returns a string containing a concise, human-readable description of this object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Methods inherited from class android.database.sqlite.SQLiteClosable
acquireReference, close, onAllReferencesReleasedFromContainer, releaseReference, releaseReferenceFromContainer

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

- Field Detail
  - mWindowPtr
```
public int mWindowPtr
```
    The native CursorWindow object pointer. (FOR INTERNAL USE ONLY)
  - CREATOR
```
public static final Parcelable.Creator<CursorWindow> CREATOR
```
- Constructor Detail
  - CursorWindow
```
public CursorWindow(String name)
```
    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.
    
    Parameters:
    name - The name of the cursor window, or null if none.
  - CursorWindow
```
@Deprecated
public CursorWindow(boolean localWindow)
```
    Deprecated. There is no longer a distinction between local and remote cursor windows. Use the CursorWindow(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.
    
    Parameters:
    localWindow - True if this window will be used in this process only, false if it might be sent to another processes. This argument is ignored.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: Object
    
    Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
    Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.
    If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.
    Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.
    Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - getName
```
public String getName()
```
    Gets the name of this cursor window, never null.
  - clear
```
public void clear()
```
    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.
  - getStartPosition
```
public int getStartPosition()
```
    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.
    
    Returns:
    The zero-based start position.
  - setStartPosition
```
public void setStartPosition(int pos)
```
    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.
    
    Parameters:
    pos - The new zero-based start position.
  - getNumRows
```
public int getNumRows()
```
    Gets the number of rows in this window.
    
    Returns:
    The number of rows in this cursor window.
  - setNumColumns
```
public boolean setNumColumns(int columnNum)
```
    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.
    
    Parameters:
    columnNum - The new number of columns.
    
    Returns:
    True if successful.
  - allocRow
```
public boolean allocRow()
```
    Allocates a new row at the end of this cursor window.
    
    Returns:
    True if successful, false if the cursor window is out of memory.
  - freeLastRow
```
public void freeLastRow()
```
    Frees the last row in this cursor window.
  - isNull
```
@Deprecated
public boolean isNull(int row,
                        int column)
```
    Deprecated. Use getType(int, int) instead.
    
    Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_NULL.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if the field has type Cursor.FIELD_TYPE_NULL.
  - isBlob
```
@Deprecated
public boolean isBlob(int row,
                        int column)
```
    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.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if the field has type Cursor.FIELD_TYPE_BLOB or Cursor.FIELD_TYPE_NULL.
  - isLong
```
@Deprecated
public boolean isLong(int row,
                        int column)
```
    Deprecated. Use getType(int, int) instead.
    
    Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_INTEGER.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if the field has type Cursor.FIELD_TYPE_INTEGER.
  - isFloat
```
@Deprecated
public boolean isFloat(int row,
                         int column)
```
    Deprecated. Use getType(int, int) instead.
    
    Returns true if the field at the specified row and column index has type Cursor.FIELD_TYPE_FLOAT.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if the field has type Cursor.FIELD_TYPE_FLOAT.
  - isString
```
@Deprecated
public boolean isString(int row,
                          int column)
```
    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.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if the field has type Cursor.FIELD_TYPE_STRING or Cursor.FIELD_TYPE_NULL.
  - getType
```
public int getType(int row,
          int column)
```
    Returns the type of the field at the specified row and column index.
    The returned field types are:
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The field type.
  - getBlob
```
public byte[] getBlob(int row,
             int column)
```
    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.
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as a byte array.
  - getString
```
public String getString(int row,
               int column)
```
    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.
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as a string.
  - copyStringToBuffer
```
public void copyStringToBuffer(int row,
                      int column,
                      CharArrayBuffer buffer)
```
    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.
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    buffer - The CharArrayBuffer to hold the string. It is automatically resized if the requested string is larger than the buffer's current capacity.
  - getLong
```
public long getLong(int row,
           int column)
```
    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.
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as a long.
  - getDouble
```
public double getDouble(int row,
               int column)
```
    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.
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as a double.
  - getShort
```
public short getShort(int row,
             int column)
```
    Gets the value of the field at the specified row and column index as a short.
    The result is determined by invoking getLong(int, int) and converting the result to short.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as a short.
  - getInt
```
public int getInt(int row,
         int column)
```
    Gets the value of the field at the specified row and column index as an int.
    The result is determined by invoking getLong(int, int) and converting the result to int.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as an int.
  - getFloat
```
public float getFloat(int row,
             int column)
```
    Gets the value of the field at the specified row and column index as a float.
    The result is determined by invoking getDouble(int, int) and converting the result to float.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    The value of the field as an float.
  - putBlob
```
public boolean putBlob(byte[] value,
              int row,
              int column)
```
    Copies a byte array into the field at the specified row and column index.
    
    Parameters:
    value - The value to store.
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if successful.
  - putString
```
public boolean putString(String value,
                int row,
                int column)
```
    Copies a string into the field at the specified row and column index.
    
    Parameters:
    value - The value to store.
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if successful.
  - putLong
```
public boolean putLong(long value,
              int row,
              int column)
```
    Puts a long integer into the field at the specified row and column index.
    
    Parameters:
    value - The value to store.
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if successful.
  - putDouble
```
public boolean putDouble(double value,
                int row,
                int column)
```
    Puts a double-precision floating point value into the field at the specified row and column index.
    
    Parameters:
    value - The value to store.
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if successful.
  - putNull
```
public boolean putNull(int row,
              int column)
```
    Puts a null value into the field at the specified row and column index.
    
    Parameters:
    row - The zero-based row index.
    column - The zero-based column index.
    
    Returns:
    True if successful.
  - newFromParcel
```
public static CursorWindow newFromParcel(Parcel p)
```
  - describeContents
```
public int describeContents()
```
    Description copied from interface: Parcelable
    
    Describe the kinds of special objects contained in this Parcelable's marshalled representation.
    
    Specified by:
    
    describeContents in interface Parcelable
    
    Returns:
    a bitmask indicating the set of special object types marshalled by the Parcelable.
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                 int flags)
```
    Description copied from interface: Parcelable
    
    Flatten this object in to a Parcel.
    
    Specified by:
    
    writeToParcel in interface Parcelable
    
    Parameters:
    dest - The Parcel in which the object should be written.
    flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
  - onAllReferencesReleased
```
protected void onAllReferencesReleased()
```
    Description copied from class: SQLiteClosable
    
    Called when the last reference to the object was released by a call to SQLiteClosable.releaseReference() or SQLiteClosable.close().
    
    Specified by:
    
    onAllReferencesReleased in class SQLiteClosable
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
```
   getClass().getName() + '@' + Integer.toHexString(hashCode())
```
    See Writing a useful toString method if you intend implementing your own toString method.
    Overrides:
    
    toString in class Object
    
    Returns:
    a printable representation of this object.

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

CursorWindow

Class CursorWindow

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class android.database.sqlite.SQLiteClosable

Methods inherited from class java.lang.Object

Field Detail

mWindowPtr

CREATOR

Constructor Detail

CursorWindow

CursorWindow

Method Detail

finalize

getName

clear

getStartPosition

setStartPosition

getNumRows

setNumColumns

allocRow

freeLastRow

isNull

isBlob

isLong

isFloat

isString

getType

getBlob

getString

copyStringToBuffer

getLong

getDouble

getShort

getInt

getFloat

putBlob

putString

putLong

putDouble

putNull

newFromParcel

describeContents

writeToParcel

onAllReferencesReleased

toString

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