summaryrefslogtreecommitdiffstats
path: root/src/SettingsRepositoryInterface.h
diff options
context:
space:
mode:
authorAlexander Harkness <bearbin@gmail.com>2015-05-19 19:43:19 +0200
committerAlexander Harkness <bearbin@gmail.com>2015-05-19 19:43:19 +0200
commitcbb425f027a7b51c4aed5d3399b26cf325c4c8ce (patch)
tree6a35f2c9c44b7d3d5142635178bf1ec9ca5e428c /src/SettingsRepositoryInterface.h
parentUpdated Core. (diff)
parentMerge pull request #2057 from Seadragon91/master (diff)
downloadcuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar.gz
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar.bz2
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar.lz
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar.xz
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.tar.zst
cuberite-cbb425f027a7b51c4aed5d3399b26cf325c4c8ce.zip
Diffstat (limited to 'src/SettingsRepositoryInterface.h')
-rw-r--r--src/SettingsRepositoryInterface.h61
1 files changed, 61 insertions, 0 deletions
diff --git a/src/SettingsRepositoryInterface.h b/src/SettingsRepositoryInterface.h
new file mode 100644
index 000000000..443b90ff5
--- /dev/null
+++ b/src/SettingsRepositoryInterface.h
@@ -0,0 +1,61 @@
+
+#pragma once
+
+class cSettingsRepositoryInterface
+{
+public:
+
+ enum errors
+ {
+ noID = -1,
+ };
+
+ virtual ~cSettingsRepositoryInterface() = default;
+
+ /** Returns true iff the specified key exists */
+ virtual bool KeyExists(const AString keyname) const = 0;
+
+ /** Returns true iff the specified value exists. */
+ virtual bool HasValue(const AString & a_KeyName, const AString & a_ValueName) const = 0;
+
+ /** Add a key name. Return value is not required to mean anything **/
+ virtual int AddKeyName(const AString & keyname) = 0;
+
+ /** Add a key comment, will always fail if the repository does not support comments **/
+ virtual bool AddKeyComment(const AString & keyname, const AString & comment) = 0;
+
+ /** Return a key comment, returns "" for repositories that do not return comments **/
+ virtual AString GetKeyComment(const AString & keyname, const int commentID) const = 0;
+
+ /** Delete a key comment, will always fail if the repository does not support comments **/
+ virtual bool DeleteKeyComment(const AString & keyname, const int commentID) = 0;
+
+ /** Adds a new value to the specified key.
+ If a value of the same name already exists, creates another one **/
+ virtual void AddValue (const AString & a_KeyName, const AString & a_ValueName, const AString & a_Value) = 0;
+
+ /** returns a vector containing a name, value pair for each value under the key **/
+ virtual std::vector<std::pair<AString, AString>> GetValues(AString a_keyName) = 0;
+
+ /** Get the value at the specified key and value, returns defValue on failure **/
+ virtual AString GetValue (const AString & keyname, const AString & valuename, const AString & defValue = "") const = 0;
+
+ /** Gets the value; if not found, write the default to the repository **/
+ virtual AString GetValueSet (const AString & keyname, const AString & valuename, const AString & defValue = "") = 0;
+ virtual int GetValueSetI(const AString & keyname, const AString & valuename, const int defValue = 0) = 0;
+ virtual Int64 GetValueSetI(const AString & keyname, const AString & valuename, const Int64 defValue = 0) = 0;
+ virtual bool GetValueSetB(const AString & keyname, const AString & valuename, const bool defValue = false) = 0;
+
+ /** Overwrites the value of the key, value pair
+ Specify the optional parameter as false if you do not want the value created if it doesn't exist.
+ Returns true if value set, false otherwise. **/
+ virtual bool SetValue (const AString & a_KeyName, const AString & a_ValueName, const AString & a_Value, const bool a_CreateIfNotExists = true) = 0;
+ virtual bool SetValueI(const AString & a_KeyName, const AString & a_ValueName, const int a_Value, const bool a_CreateIfNotExists = true) = 0;
+
+ /** Deletes the specified key, value pair **/
+ virtual bool DeleteValue(const AString & keyname, const AString & valuename) = 0;
+
+
+ /** Writes the changes to the backing store, if the repository has one **/
+ virtual bool Flush() = 0;
+};