ContentQueryMap

Kotlin |Java

open class ContentQueryMap : Observable

kotlin.Any
↳	java.util.Observable
	↳	android.content.ContentQueryMap

Caches the contents of a cursor into a Map of String->ContentValues and optionally keeps the cache fresh by registering for updates on the content backing the cursor. The column of the database that is to be used as the key of the map is user-configurable, and the ContentValues contains all columns other than the one that is designated the key.

The cursor data is accessed by row key and column name via getValue().

Summary

Public constructors
`ContentQueryMap(cursor: Cursor!, columnNameOfKey: String!, keepUpdated: Boolean, handlerForUpdateNotifications: Handler!)` Creates a ContentQueryMap that caches the content backing the cursor

Public methods
open Unit	`close()`
open MutableMap<String!, ContentValues!>!	`getRows()`
open ContentValues!	`getValues(rowName: String!)` Access the ContentValues for the row specified by rowName
open Unit	`requery()` Requeries the cursor and reads the contents into the cache
open Unit	`setKeepUpdated(keepUpdated: Boolean)` Change whether or not the ContentQueryMap will register with the cursor's ContentProvider for change notifications.

Protected methods
open Unit	`finalize()`

Inherited functions

From class Observable

`Unit`	`addObserver(o: Observer!)` Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. The order in which notifications will be delivered to multiple observers is not specified. See the class comment.
`Unit`	`clearChanged()` Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the `hasChanged` method will now return `false`. This method is called automatically by the `notifyObservers` methods.
`Int`	`countObservers()` Returns the number of observers of this `Observable` object.
`Unit`	`deleteObserver(o: Observer!)` Deletes an observer from the set of observers of this object. Passing `null` to this method will have no effect.
`Unit`	`deleteObservers()` Clears the observer list so that this object no longer has any observers.
`Boolean`	`hasChanged()` Tests if this object has changed.
`Unit`	`notifyObservers()` If this object has changed, as indicated by the `hasChanged` method, then notify all of its observers and then call the `clearChanged` method to indicate that this object has no longer changed. Each observer has its `update` method called with two arguments: this observable object and `null`. In other words, this method is equivalent to: `notifyObservers(null)`
`Unit`	`notifyObservers(arg: Any!)` If this object has changed, as indicated by the `hasChanged` method, then notify all of its observers and then call the `clearChanged` method to indicate that this object has no longer changed. Each observer has its `update` method called with two arguments: this observable object and the `arg` argument.
`Unit`	`setChanged()` Marks this `Observable` object as having been changed; the `hasChanged` method will now return `true`.

Public constructors

ContentQueryMap

Added in API level 1

ContentQueryMap(
    cursor: Cursor!, 
    columnNameOfKey: String!, 
    keepUpdated: Boolean, 
    handlerForUpdateNotifications: Handler!)

Creates a ContentQueryMap that caches the content backing the cursor

Parameters
`cursor`	Cursor!: the cursor whose contents should be cached
`columnNameOfKey`	String!: the column that is to be used as the key of the values map
`keepUpdated`	Boolean: true if the cursor's ContentProvider should be monitored for changes and the map updated when changes do occur
`handlerForUpdateNotifications`	Handler!: the Handler that should be used to receive notifications of changes (if requested). Normally you pass null here, but if you know that the thread that is creating this isn't a thread that can receive messages then you can create your own handler and use that here.

Public methods

close

Added in API level 1

open fun close(): Unit

getRows

Added in API level 1

open fun getRows(): MutableMap<String!, ContentValues!>!

getValues

Added in API level 1

open fun getValues(rowName: String!): ContentValues!

Access the ContentValues for the row specified by rowName

Parameters
`rowName`	String!: which row to read

Return
`ContentValues!`	the ContentValues for the row, or null if the row wasn't present in the cursor

requery

Added in API level 1

open fun requery(): Unit

Requeries the cursor and reads the contents into the cache

setKeepUpdated

Added in API level 1

open fun setKeepUpdated(keepUpdated: Boolean): Unit

Change whether or not the ContentQueryMap will register with the cursor's ContentProvider for change notifications. If you use a ContentQueryMap in an activity you should call this with false in onPause(), which means you need to call it with true in onResume() if want it to be kept updated.

Parameters
`keepUpdated`	Boolean: if true the ContentQueryMap should be registered with the cursor's ContentProvider, false otherwise

Protected methods

finalize

Added in API level 1

protected open fun finalize(): Unit

Exceptions
`java.lang.Throwable`	the `Exception` raised by this method