Stay organized with collections
Save and categorize content based on your preferences.
KeyValueStore
public
interface
KeyValueStore
| android.adservices.ondevicepersonalization.KeyValueStore
|
Known indirect subclasses
|
An interface to a read-only key-value store.
Used as a Data Access Object for the REMOTE_DATA table.
Summary
Public methods |
|---|
abstract
byte[]
|
get(String key)
Looks up a key in a read-only store.
|
abstract
Set<String>
|
keySet()
Returns a Set view of the keys contained in the REMOTE_DATA table.
|
Public methods
get
public abstract byte[] get (String key)
Looks up a key in a read-only store.
This method may take several seconds to complete, so it should
only be called from a worker thread.
| Parameters |
|---|
key |
String: The key to look up.
This value cannot be null. |
| Returns |
|---|
byte[] |
the value to which the specified key is mapped,
or null if there contains no mapping for the key. |
keySet
public abstract Set<String> keySet ()
Returns a Set view of the keys contained in the REMOTE_DATA table.
This method may take several seconds to complete, so it should
only be called from a worker thread.
| Returns |
|---|
Set<String> |
This value cannot be null. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# KeyValueStore\n\n[**Added in Android UpsideDownCakePrivacySandbox**](/preview) \nSummary: [Methods](#pubmethods) \n\nKeyValueStore\n=============\n\n\n`\npublic\n\n\ninterface\nKeyValueStore\n`\n\n\n`\n\n\n`\n\n|----------------------------------------------------------|\n| android.adservices.ondevicepersonalization.KeyValueStore |\n\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known indirect subclasses [MutableKeyValueStore](/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/MutableKeyValueStore) |------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| | [MutableKeyValueStore](/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/MutableKeyValueStore) | An interface to a read-write key-value store. | |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nAn interface to a read-only key-value store.\n\nUsed as a Data Access Object for the REMOTE_DATA table. \n**See also:**\n\n- [IsolatedService.getRemoteData(RequestToken)](/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/IsolatedService#getRemoteData(android.adservices.ondevicepersonalization.RequestToken))\n\nSummary\n-------\n\n| ### Public methods ||\n|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract byte[]` | ` `[get](/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/KeyValueStore#get(java.lang.String))`(`[String](/reference/java/lang/String)` key) ` Looks up a key in a read-only store. |\n| ` abstract `[Set](/reference/java/util/Set)`\u003c`[String](/reference/java/lang/String)`\u003e` | ` `[keySet](/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/KeyValueStore#keySet())`() ` Returns a Set view of the keys contained in the REMOTE_DATA table. |\n\nPublic methods\n--------------\n\n### get\n\n[**Added in Android UpsideDownCakePrivacySandbox**](/preview) \n\n```\npublic abstract byte[] get (String key)\n```\n\nLooks up a key in a read-only store.\n\n\u003cbr /\u003e\n\n\nThis method may take several seconds to complete, so it should\nonly be called from a worker thread.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------|-------------------------------------------------------------------|\n| `key` | `String`: The key to look up. This value cannot be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `byte[]` | the value to which the specified key is mapped, or null if there contains no mapping for the key. \u003cbr /\u003e |\n\n### keySet\n\n[**Added in Android UpsideDownCakePrivacySandbox**](/preview) \n\n```\npublic abstract Set\u003cString\u003e keySet ()\n```\n\nReturns a Set view of the keys contained in the REMOTE_DATA table.\n\n\u003cbr /\u003e\n\n\nThis method may take several seconds to complete, so it should\nonly be called from a worker thread.\n\n\u003cbr /\u003e\n\n| Returns ||\n|----------------------------------------------------------------------------|-------------------------------------|\n| [Set](/reference/java/util/Set)`\u003c`[String](/reference/java/lang/String)`\u003e` | This value cannot be `null`. \u003cbr /\u003e |"]]
