blob: bd66ecb1727b1ddb4a13fd8ceb7858fa7498dad6 [file] [log] [blame]
Darin Petkov63138a92012-02-06 14:09:15 +01001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
mukesh agrawal7a4e4002011-09-06 11:26:05 -07002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef SHILL_KEY_VALUE_STORE_
6#define SHILL_KEY_VALUE_STORE_
7
8#include <map>
9#include <string>
10
11#include <base/basictypes.h>
12
13namespace shill {
14
15class KeyValueStore {
16 // A simple store for key-value pairs, which supports (a limited set of)
17 // heterogenous value types.
18 //
19 // Compare to PropertyStore, which enables a class to (selectively)
20 // expose its instance members as properties accessible via
21 // RPC. (RPC support for ProperyStore is implemented in a
22 // protocol-specific adaptor. e.g. dbus_adpator.)
23 //
24 // Implemented separately from PropertyStore, to avoid complicating
25 // the PropertyStore interface. In particular, objects implementing the
26 // PropertyStore interface always provide the storage themselves. In
27 // contrast, users of KeyValueStore expect KeyValueStore to provide
28 // storage.
29 public:
30 KeyValueStore();
31
Paul Stewartdef189e2012-08-02 20:12:09 -070032 void Clear();
33
mukesh agrawal7a4e4002011-09-06 11:26:05 -070034 bool ContainsBool(const std::string &name) const;
Paul Stewart1062d9d2012-04-27 10:42:27 -070035 bool ContainsInt(const std::string &name) const;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070036 bool ContainsString(const std::string &name) const;
Darin Petkov63138a92012-02-06 14:09:15 +010037 bool ContainsUint(const std::string &name) const;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070038
39 bool GetBool(const std::string &name) const;
Paul Stewart1062d9d2012-04-27 10:42:27 -070040 int32 GetInt(const std::string &name) const;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070041 const std::string &GetString(const std::string &name) const;
Darin Petkov63138a92012-02-06 14:09:15 +010042 uint32 GetUint(const std::string &name) const;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070043
44 void SetBool(const std::string &name, bool value);
Paul Stewart1062d9d2012-04-27 10:42:27 -070045 void SetInt(const std::string &name, int32 value);
Darin Petkov63138a92012-02-06 14:09:15 +010046 void SetString(const std::string& name, const std::string& value);
47 void SetUint(const std::string &name, uint32 value);
48
Paul Stewart88125fb2012-03-26 07:13:51 -070049 void RemoveString(const std::string &name);
Paul Stewart1062d9d2012-04-27 10:42:27 -070050 void RemoveInt(const std::string &name);
Paul Stewart88125fb2012-03-26 07:13:51 -070051
Darin Petkov7f060332012-03-14 11:46:47 +010052 // If |name| is in this store returns its value, otherwise returns
53 // |default_value|.
Darin Petkovb536a742012-04-26 11:31:28 +020054 bool LookupBool(const std::string &name, bool default_value) const;
Darin Petkov7f060332012-03-14 11:46:47 +010055 std::string LookupString(const std::string &name,
56 const std::string &default_value) const;
57
Darin Petkov63138a92012-02-06 14:09:15 +010058 const std::map<std::string, bool> &bool_properties() const {
59 return bool_properties_;
60 }
Paul Stewart1062d9d2012-04-27 10:42:27 -070061 const std::map<std::string, int32> &int_properties() const {
62 return int_properties_;
63 }
Darin Petkov63138a92012-02-06 14:09:15 +010064 const std::map<std::string, std::string> &string_properties() const {
65 return string_properties_;
66 }
67 const std::map<std::string, uint32> &uint_properties() const {
68 return uint_properties_;
69 }
mukesh agrawal7a4e4002011-09-06 11:26:05 -070070
71 private:
72 std::map<std::string, bool> bool_properties_;
Paul Stewart1062d9d2012-04-27 10:42:27 -070073 std::map<std::string, int32> int_properties_;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070074 std::map<std::string, std::string> string_properties_;
Darin Petkov63138a92012-02-06 14:09:15 +010075 std::map<std::string, uint32> uint_properties_;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070076};
77
78} // namespace shill
79
80#endif // SHILL_KEY_VALUE_STORE_