00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 #ifndef INCL_ARRAYLIST_KEY_VALUE_STORE 00037 #define INCL_ARRAYLIST_KEY_VALUE_STORE 00038 /** @cond API */ 00039 /** @addtogroup Client */ 00040 /** @{ */ 00041 00042 #include "base/fscapi.h" 00043 #include "base/util/KeyValuePair.h" 00044 #include "base/util/KeyValueStore.h" 00045 #include "base/util/ArrayListEnumeration.h" 00046 #include "base/globalsdef.h" 00047 00048 BEGIN_NAMESPACE 00049 00050 /** 00051 * This is the interface for the handling of the key/value that 00052 * has to be written in the storage. It provides methods that has to be 00053 * specialized by implementation on filesystem, registry, db... 00054 */ 00055 class ArrayListKeyValueStore : public KeyValueStore { 00056 00057 protected: 00058 00059 /** 00060 * The list contains the pair key/value that are what is in the file that is 00061 * in the form key:value 00062 */ 00063 ArrayListEnumeration data; 00064 00065 public: 00066 // Destructor 00067 virtual ~ArrayListKeyValueStore() {} 00068 00069 /** 00070 * Read a property value from the data ArrayList 00071 */ 00072 virtual StringBuffer readPropertyValue(const char *prop) const; 00073 00074 /* 00075 * Sets a property value in the data ArrayList 00076 * 00077 * @param prop - the property name 00078 * @param value - the property value (zero terminated string) 00079 */ 00080 virtual int setPropertyValue(const char *prop, const char *value); 00081 00082 /** 00083 * Remove a certain property from the data ArrayList 00084 * 00085 * @param prop the name of the property which is to be removed 00086 * @return int 0 on success, an error code otherwise 00087 */ 00088 virtual int removeProperty(const char *prop); 00089 00090 /** 00091 * Read all the properties that are in the store. This is 00092 * an enumeration of KeyValuePairs. 00093 * 00094 */ 00095 virtual Enumeration& getProperties() const { 00096 return (Enumeration&)data; 00097 } 00098 00099 /** 00100 * Save the current properties that are 00101 * in the data arraylist 00102 * @return 0 - success, failure otherwise 00103 */ 00104 virtual int save() = 0; 00105 }; 00106 00107 00108 END_NAMESPACE 00109 00110 /** @} */ 00111 /** @endcond */ 00112 #endif