Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(54)

Side by Side Diff: chrome/browser/extensions/extension_settings_storage.h

Issue 7189029: Implement an initial extension settings API. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk
Patch Set: Use base::Closure for storage callback, style fixes, mac/windows fixes Created 9 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
(Empty)
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_SETTINGS_STORAGE_H_
6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_SETTINGS_STORAGE_H_
7 #pragma once
8
9 #include "base/values.h"
10
11 // Interface for extension settings storage classes.
12 //
13 // All asynchrous methods *must* run in a message loop, i.e. the callbacks may
14 // not be run from the calling method, but must be PostTask'ed (whether to
15 // one's own thread or to e.g. the FILE thread).
16 class ExtensionSettingsStorage {
17 public:
18 // Asynchronous results of Set/Get/Remove. Exactly one of OnSuccess or
19 // OnFailure will eventually be called.
20 // Callback objects will be deleted after running.
21 class Callback {
22 public:
23 virtual ~Callback() {}
24
25 // Indicates the storage operation was successful. Settings value will be
26 // non-NULL. Ownership is passed to the callback.
27 virtual void OnSuccess(DictionaryValue* settings) = 0;
28
29 // Indicates the storage operation failed. Messages describes the failure.
30 virtual void OnFailure(const std::string& message) = 0;
31 };
32
33 virtual ~ExtensionSettingsStorage() {}
34
35 // The different types of extension settings storage.
36 enum Type {
37 NONE,
38 NOOP,
39 LEVELDB
40 };
41
42 // Destroys this settings storage object. This is needed as a separate
43 // interface method as opposed to just using the destructor, since
44 // destruction may need to be done asynchronously (e.g. on the FILE thread).
45 virtual void DestroyEventually() = 0;
Matt Perry 2011/06/23 19:14:11 nit: name this DeleteSoon to be consistent with ot
not at google - send to devlin 2011/06/27 08:51:02 Done.
46
47 // Gets a single value from storage. Callback with a dictionary mapping the
48 // key to its value, if any.
49 virtual void Get(const std::string& key, Callback* callback) = 0;
50
51 // Gets multiple values from storage. Callback with a dictionary mapping
52 // each key to its value, if any.
53 virtual void Get(const ListValue& keys, Callback* callback) = 0;
54
55 // Gets all values from storage. Callback with a dictionary mapping every
56 // key to its value.
57 virtual void Get(Callback* callback) = 0;
58
59 // Sets a single key to a new value. Callback with a dictionary mapping the
60 // key to its new value; on success, this is guaranteed to be the given key
61 // to the given new value.
62 virtual void Set(const std::string& key, const Value& value,
63 Callback* callback) = 0;
64
65 // Sets multiple keys to new values. Callback with a dictionary mapping each
66 // key to its new value; on success, this is guaranteed to be each given key
67 // to its given new value.
68 virtual void Set(const DictionaryValue& values, Callback* callback) = 0;
69
70 // Removes a key from the map. Callback with a dictionary mapping the key
71 // to its new value; on success, this will be an empty map.
72 virtual void Remove(const std::string& key, Callback* callback) = 0;
73
74 // Removes multiple keys from the map. Callback with a dictionary mapping
75 // each key to its new value; on success, this will be an empty map.
76 virtual void Remove(const ListValue& keys, Callback* callback) = 0;
77
78 // Clears the storage. Callback with a dictionary mapping every key in
79 // storage to its value; on success, this will be an empty map.
80 virtual void Clear(Callback *callback) = 0;
81 };
82
83 #endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_SETTINGS_STORAGE_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698