include/config/Vault.h

   1 /**
   2         Aesalon, a tool to visualize a program's behaviour at run-time.
   3         Copyright (C) 2010, Aesalon Development Team.
   4
   5         Aesalon is distributed under the terms of the GNU GPLv3. For more
   6         licensing information, see the file LICENSE included with the distribution.
   7
   8         @file include/monitor/config/Vault.h
   9
  10 */
  11
  12 #ifndef AesalonMonitor_Config_Vault_H
  13 #define AesalonMonitor_Config_Vault_H
  14
  15 #include <string>
  16 #include <vector>
  17
  18 namespace Monitor {
  19 namespace Config {
  20
  21 class Vault {
  22 public:
  23         typedef std::pair<std::string, std::string> KeyPair;
  24         virtual ~Vault() {}
  25
  26         /** Clears @a key to have no value.
  27         */
  28         virtual void clear(const std::string &key) = 0;
  29         /** Sets @a key to @a value.
  30         */
  31         virtual void set(const std::string &key, const std::string &value) = 0;
  32
  33         /** Returns the last value that @a key maps to.
  34         */
  35         virtual std::string get(const std::string &key) = 0;
  36         /** Stores all the values of @a key in @a values.
  37         */
  38         virtual void get(const std::string &key, std::vector<std::string> &values) = 0;
  39         /** Places the names of all strings that match @a pattern into @a keys. Note that
  40                 @a keys will not be cleared.
  41         */
  42         virtual void match(const std::string &pattern, std::vector<KeyPair> &items) = 0;
  43 };
  44
  45 } // namespace Config
  46 } // namespace Monitor
  47
  48 #endif