| java.lang.Object | ||
| ↳ | android.database.sqlite.SQLiteClosable | |
| ↳ | android.database.CursorWindow | |
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.
      
| 
         
          [Expand]
         
          
          Inherited Constants
          
         | 
       |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
         
           
         
         From interface
         
          android.os.Parcelable
         
          | 
       |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        CREATOR | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        
          
          Creates a new empty cursor window and gives it a name.
          
         | 
       ||||||||||
| 
          | 
        
          
          
           This constructor was deprecated
      in API level 15.
    There is no longer a distinction between local and remote
 cursor windows.  Use the
            
        
            
             CursorWindow(String)
            
           
           constructor instead.
          
          | 
       ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        
          
          Allocates a new row at the end of this cursor window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Clears out the existing contents of the window, making it safe to reuse
 for new data.
          
         | 
       ||||||||||
| 
          | 
        
          
          Copies the text of the field at the specified row and column index into
 a
           
        
           
            CharArrayBuffer
           
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Describe the kinds of special objects contained in this Parcelable's
 marshalled representation.
          
         | 
       ||||||||||
| 
          | 
        
          
          Frees the last row in this cursor window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a byte array.
          
         | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a
           
        
           double
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a
           
        
           float
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as an
           
        
           int
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a
           
        
           long
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Gets the number of rows in this window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a
           
        
           short
          
          .
          | 
       ||||||||||
| 
          | 
        
          
          Gets the start position of this cursor window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Gets the value of the field at the specified row and column index as a string.
          
         | 
       ||||||||||
| 
          | 
        
          
          Returns the type of the field at the specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          
           This method was deprecated
      in API level 11.
    Use
            
        
            
             getType(int, int)
            
           
           instead.
          
          | 
       ||||||||||
| 
          | 
        
          
          
           This method was deprecated
      in API level 11.
    Use
            
        
            
             getType(int, int)
            
           
           instead.
          
          | 
       ||||||||||
| 
          | 
        
          
          
           This method was deprecated
      in API level 11.
    Use
            
        
            
             getType(int, int)
            
           
           instead.
          
          | 
       ||||||||||
| 
          | 
        
          
          
           This method was deprecated
      in API level 11.
    Use
            
        
            
             getType(int, int)
            
           
           instead.
          
          | 
       ||||||||||
| 
          | 
        
          
          
           This method was deprecated
      in API level 11.
    Use
            
        
            
             getType(int, int)
            
           
           instead.
          
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          
          Copies a byte array into the field at the specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          Puts a double-precision floating point value into the field at the
 specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          Puts a long integer into the field at the specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          Puts a null value into the field at the specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          Copies a string into the field at the specified row and column index.
          
         | 
       ||||||||||
| 
          | 
        
          
          Sets the number of columns in this window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Sets the start position of this cursor window.
          
         | 
       ||||||||||
| 
          | 
        
          
          Returns a string containing a concise, human-readable description of this
 object.
          
         | 
       ||||||||||
| 
          | 
        
          
          Flatten this object in to a Parcel.
          
         | 
       ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        
          
          Invoked when the garbage collector has detected that this instance is no longer reachable.
          
         | 
       ||||||||||
| 
          | 
        
          
          Called when the last reference to the object was released by
 a call to
           
        
           
            releaseReference()
           
          
          or
          
           
            close()
           
          
          .
          | 
       ||||||||||
| 
         
          [Expand]
         
          
          Inherited Methods
          
         | 
       |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
         
           
         
         From class
         
          android.database.sqlite.SQLiteClosable
         
          | 
       |||||||||||
         
           
         
         From class
         
          java.lang.Object
         
          | 
       |||||||||||
         
           
         
         From interface
         
          android.os.Parcelable
         
          | 
       |||||||||||
         
           
         
         From interface
         
          java.io.Closeable
         
          | 
       |||||||||||
         
           
         
         From interface
         
          java.lang.AutoCloseable
         
          | 
       |||||||||||
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.
        
| name | The name of the cursor window, or null if none. | 
|---|
        
         This constructor was deprecated
      in API level 15.
        
        
        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.
        
| 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. | 
|---|
Allocates a new row at the end of this cursor window.
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.
        
         Copies the text of the field at the specified row and column index into
 a
         
          
           CharArrayBuffer
          
         
         .
        
The buffer is populated as follows:
            
             FIELD_TYPE_NULL
            
           
           , then the buffer
 is set to an empty string.
          
            
             FIELD_TYPE_STRING
            
           
           , then the buffer
 is set to the contents of the string.
          
            
             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
           
           .
          
            
             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
           
           .
          
            
             FIELD_TYPE_BLOB
            
           
           , then a
           
            
             SQLiteException
            
           
           is thrown.
          | 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.
           | 
         
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Gets the value of the field at the specified row and column index as a byte array.
The result is determined as follows:
            
             FIELD_TYPE_NULL
            
           
           , then the result
 is
           
            null
           
           .
          
            
             FIELD_TYPE_BLOB
            
           
           , then the result
 is the blob value.
          
            
             FIELD_TYPE_STRING
            
           
           , then the result
 is the array of bytes that make up the internal representation of the
 string value.
          
            
             FIELD_TYPE_INTEGER
            
           
           or
           
            
             FIELD_TYPE_FLOAT
            
           
           , then a
           
            
             SQLiteException
            
           
           is thrown.
          | row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
         Gets the value of the field at the specified row and column index as a
         
          double
         
         .
        
The result is determined as follows:
            
             FIELD_TYPE_NULL
            
           
           , then the result
 is
           
            0.0
           
           .
          
            
             FIELD_TYPE_STRING
            
           
           , then the result
 is the value obtained by parsing the string value with
           
            strtod
           
           .
          
            
             FIELD_TYPE_INTEGER
            
           
           , then the result
 is the integer value converted to a
           
            double
           
           .
          
            
             FIELD_TYPE_FLOAT
            
           
           , then the result
 is the
           
            double
           
           value.
          
            
             FIELD_TYPE_BLOB
            
           
           , then a
           
            
             SQLiteException
            
           
           is thrown.
          | row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           double
          
          .
         
         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
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           float
          
          .
         
         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
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           int
          
          .
         
         Gets the value of the field at the specified row and column index as a
         
          long
         
         .
        
The result is determined as follows:
            
             FIELD_TYPE_NULL
            
           
           , then the result
 is
           
            0L
           
           .
          
            
             FIELD_TYPE_STRING
            
           
           , then the result
 is the value obtained by parsing the string value with
           
            strtoll
           
           .
          
            
             FIELD_TYPE_INTEGER
            
           
           , then the result
 is the
           
            long
           
           value.
          
            
             FIELD_TYPE_FLOAT
            
           
           , then the result
 is the floating-point value converted to a
           
            long
           
           .
          
            
             FIELD_TYPE_BLOB
            
           
           , then a
           
            
             SQLiteException
            
           
           is thrown.
          | row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           long
          
          .
         Gets the number of rows in this window.
         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
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           short
          
          .
         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
          
         
         .
        
Gets the value of the field at the specified row and column index as a string.
The result is determined as follows:
            
             FIELD_TYPE_NULL
            
           
           , then the result
 is
           
            null
           
           .
          
            
             FIELD_TYPE_STRING
            
           
           , then the result
 is the string value.
          
            
             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
           
           .
          
            
             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
           
           .
          
            
             FIELD_TYPE_BLOB
            
           
           , then a
           
            
             SQLiteException
            
           
           is thrown.
          | row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
Returns the type of the field at the specified row and column index.
The returned field types are:
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
        
         This method was deprecated
      in API level 11.
        
        
        Use
        
         
          getType(int, int)
         
        
        instead.
       
         Returns true if the field at the specified row and column index
 has type
         
          
           FIELD_TYPE_BLOB
          
         
         or
         
          
           FIELD_TYPE_NULL
          
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           
            FIELD_TYPE_BLOB
           
          
          or
          
           
            FIELD_TYPE_NULL
           
          
          .
         
        
         This method was deprecated
      in API level 11.
        
        
        Use
        
         
          getType(int, int)
         
        
        instead.
       
         Returns true if the field at the specified row and column index
 has type
         
          
           FIELD_TYPE_FLOAT
          
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           
            FIELD_TYPE_FLOAT
           
          
          .
         
        
         This method was deprecated
      in API level 11.
        
        
        Use
        
         
          getType(int, int)
         
        
        instead.
       
         Returns true if the field at the specified row and column index
 has type
         
          
           FIELD_TYPE_INTEGER
          
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           
            FIELD_TYPE_INTEGER
           
          
          .
         
        
         This method was deprecated
      in API level 11.
        
        
        Use
        
         
          getType(int, int)
         
        
        instead.
       
         Returns true if the field at the specified row and column index
 has type
         
          
           FIELD_TYPE_NULL
          
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           
            FIELD_TYPE_NULL
           
          
          .
         
        
         This method was deprecated
      in API level 11.
        
        
        Use
        
         
          getType(int, int)
         
        
        instead.
       
         Returns true if the field at the specified row and column index
 has type
         
          
           FIELD_TYPE_STRING
          
         
         or
         
          
           FIELD_TYPE_NULL
          
         
         .
        
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
           
            FIELD_TYPE_STRING
           
          
          or
          
           
            FIELD_TYPE_NULL
           
          
          .
         Copies a byte array into the field at the specified row and column index.
| value | The value to store. | 
|---|---|
| row | The zero-based row index. | 
| column | The zero-based column index. | 
Puts a double-precision floating point value into the field at the specified row and column index.
| value | The value to store. | 
|---|---|
| row | The zero-based row index. | 
| column | The zero-based column index. | 
Puts a long integer into the field at the specified row and column index.
| value | The value to store. | 
|---|---|
| row | The zero-based row index. | 
| column | The zero-based column index. | 
Puts a null value into the field at the specified row and column index.
| row | The zero-based row index. | 
|---|---|
| column | The zero-based column index. | 
Copies a string into the field at the specified row and column index.
| value | The value to store. | 
|---|---|
| row | The zero-based row index. | 
| column | The zero-based column index. | 
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.
| columnNum | The new number of columns. | 
|---|
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
          
         
         .
        
| pos | The new zero-based start position. | 
|---|
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.
        
Flatten this object in to a Parcel.
| 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_WRITE_RETURN_VALUE
            
           
           .
           | 
         
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.
| Throwable | 
|---|
         Called when the last reference to the object was released by
 a call to
         
          
           releaseReference()
          
         
         or
         
          
           close()
          
         
         .