ArrayListKeyValueStore Class Reference
[Client]
#include <ArrayListKeyValueStore.h>
Public Member Functions | |
| virtual | ~ArrayListKeyValueStore () |
| virtual StringBuffer | readPropertyValue (const char *prop) const |
| virtual int | setPropertyValue (const char *prop, const char *value) |
| virtual int | removeProperty (const char *prop) |
| virtual Enumeration & | getProperties () const |
| virtual int | save ()=0 |
Protected Attributes | |
| ArrayListEnumeration | data |
Detailed Description
This is the interface for the handling of the key/value that has to be written in the storage. It provides methods that has to be specialized by implementation on filesystem, registry, db...Definition at line 55 of file ArrayListKeyValueStore.h.
Constructor & Destructor Documentation
| virtual ArrayListKeyValueStore::~ArrayListKeyValueStore | ( | ) | [inline, virtual] |
Definition at line 67 of file ArrayListKeyValueStore.h.
Member Function Documentation
| virtual Enumeration& ArrayListKeyValueStore::getProperties | ( | ) | const [inline, virtual] |
Read all the properties that are in the store. This is an enumeration of KeyValuePairs.
Implements KeyValueStore.
Definition at line 95 of file ArrayListKeyValueStore.h.
References data.
| virtual StringBuffer ArrayListKeyValueStore::readPropertyValue | ( | const char * | prop | ) | const [virtual] |
Read a property value from the data ArrayList
Implements KeyValueStore.
| virtual int ArrayListKeyValueStore::removeProperty | ( | const char * | prop | ) | [virtual] |
Remove a certain property from the data ArrayList
- Parameters:
-
prop the name of the property which is to be removed
- Returns:
- int 0 on success, an error code otherwise
Implements KeyValueStore.
| virtual int ArrayListKeyValueStore::save | ( | ) | [pure virtual] |
Save the current properties that are in the data arraylist
- Returns:
- 0 - success, failure otherwise
Implements KeyValueStore.
Implemented in PropertyFile.
| virtual int ArrayListKeyValueStore::setPropertyValue | ( | const char * | prop, | |
| const char * | value | |||
| ) | [virtual] |
Sets a property value.
The value might be cached inside the implementation of this interface. To ensure that it is stored persistently and to do error checking, call save().
- Parameters:
-
prop - the property name value - the property value (zero terminated string)
- Returns:
- int 0 on success, an error code otherwise
Implements KeyValueStore.
Member Data Documentation
ArrayListEnumeration ArrayListKeyValueStore::data [protected] |
The list contains the pair key/value that are what is in the file that is in the form key:value
Definition at line 63 of file ArrayListKeyValueStore.h.
Referenced by getProperties().
The documentation for this class was generated from the following file:
- build-client-api/include/common/base/util/ArrayListKeyValueStore.h
