#include <Properties.h>
Public Member Functions | |
Properties (const char *key="", const char *value="") | |
Constructor. | |
Properties (std::map< std::string, std::string > &defaults) | |
Constructor. | |
Properties (const char *defaults[], long num=LONG_MAX) | |
Constructor. | |
Properties (const Properties &prop) | |
Copy Constructor. | |
Properties & | operator= (const Properties &prop) |
Assignment operator. | |
virtual | ~Properties () |
Destructor. | |
const char * | getName () const |
const char * | getVlue () const |
const char * | getDefaultValue () const |
const std::vector< Properties * > & | getLeaf () const |
const Properties * | getRoot () const |
const std::string & | getProperty (const std::string &key) const |
Searches for the property with the specified key in this property. | |
const std::string & | getProperty (const std::string &key, const std::string &def) const |
Searches for the property with the specified key in this property. | |
const std::string & | operator[] (const std::string &key) const |
Searches for the property with the specified key in this property. | |
std::string & | operator[] (const std::string &key) |
Searches for the property with the specified key in this property. | |
const std::string & | getDefault (const std::string &key) const |
Set value as the default value to specified key's property. | |
std::string | setProperty (const std::string &key, const std::string &value) |
Sets a value associated with key in the property list. | |
std::string | setDefault (const std::string &key, const std::string &value) |
Sets a default value associated with key in the property list. | |
void | setDefaults (const char *defaults[], long num=LONG_MAX) |
Sets a default value associated with key in the property list. | |
void | list (std::ostream &out) |
Prints this property list out to the specified output stream. | |
void | load (std::istream &inStream) |
Loads property list consists of key:value from input stream. | |
void | save (std::ostream &out, const std::string &header) |
Save the properties list to the stream. | |
void | store (std::ostream &out, const std::string &header) |
Stores property list to the output stream. | |
std::vector< std::string > | propertyNames () const |
Returns an vector of all the keys in this property. | |
int | size () const |
Get number of Properties. | |
Properties * | getNode (const std::string &key) const |
Get node of Properties. | |
bool | createNode (const char *key) |
Properties * | removeNode (const char *leaf_name) |
Get node of Properties. | |
Properties * | hasKey (const char *key) const |
If key exists in the children. | |
void | clear () |
If key exists in the children. | |
Properties & | operator<< (const Properties &prop) |
Merge properties. | |
Static Protected Member Functions | |
static void | splitKeyValue (const std::string &str, std::string &key, std::string &value) |
static bool | split (const std::string &str, const char delim, std::vector< std::string > &value) |
static Properties * | _getNode (std::vector< std::string > &keys, std::vector< Properties * >::size_type index, const Properties *curr) |
static void | _propertiyNames (std::vector< std::string > &names, std::string curr_name, const Properties *curr) |
static void | _store (std::ostream &out, std::string curr_name, Properties *curr) |
static std::ostream & | _dump (std::ostream &out, const Properties &curr, int index) |
static std::string | indent (int index) |
Friends | |
std::ostream & | operator<< (std::ostream &lhs, const Properties &rhs) |
A property list can contain another property list as its "defaults"; this second property list is searched if the property key is not found in the original property list.
Because Properties inherits from Hashtable, the put and putAll methods can be applied to a Properties object. Their use is strongly discouraged as they allow the caller to insert entries whose keys or values are not Strings. The setProperty method should be used instead. If the store or save method is called on a "compromised" Properties object that contains a non-String key or value, the call will fail.
The load and store methods load and store properties in a simple line-oriented format specified below. This format uses the ISO 8859-1 character encoding. Characters that cannot be directly represented in this encoding can be written using Unicode escapes ; only a single 'u' character is allowed in an escape sequence. The native2ascii tool can be used to convert property files to and from other character encodings.
This class has almost same methods of Java's Properties class. Input and Output stream of this properties are compatible each other except Unicode encoded property file.
|
Constructor. Creates a root node of Property with root's key and value. |
|
Constructor. Creates an Properties with default value of std::string map. |
|
Constructor. Creates an empty property list with the specified defaults. The default values are given by array of char*, which should be pairs of "key" and "value". The end of list is specified by argument "num", which specifies number of array or null character of key. The following is an example. const char* defaults = { "key1", "value1", "key2", "value2", "key3", "value3", "key4", "value4", "key5", "value5", "" }; Properties p(defaults); // or Properties p(defaults, 10); |
|
Copy Constructor. All of given Properties's keys, values and default values are copied to new Properties. |
|
Destructor.
|
|
|
|
|
|
|
|
|
|
If key exists in the children.
|
|
|
|
Set value as the default value to specified key's property.
|
|
|
|
|
|
|
|
Get node of Properties.
|
|
Searches for the property with the specified key in this property. Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.
|
|
Searches for the property with the specified key in this property. Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.
|
|
|
|
|
|
If key exists in the children.
|
|
|
|
Prints this property list out to the specified output stream. Prints this property list out to the specified output stream. This method is useful for debugging.
|
|
Loads property list consists of key:value from input stream. Reads a property list (key and element pairs) from the input stream. The stream is assumed to be using the ISO 8859-1 character encoding; that is each byte is one Latin1 character. Characters not in Latin1, and certain special characters, can be represented in keys and elements using escape sequences similar to those used for character and string literals The differences from the character escape sequences used for characters and strings are:
This method processes input in terms of lines. A natural line of input is terminated either by a set of line terminator characters ( A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this method considers the characters space (' ', ''), tab ('', ''), and form feed ('', '') to be white space. If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to see if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing. The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example, \:\=
would be the two-character key ":=". Line terminator characters can be included using and As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty":
Truth = Beauty
fruits apple, banana, pear, \
cheeses
|
|
Merge properties.
|
|
Assignment operator.
|
|
Searches for the property with the specified key in this property. Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.
|
|
Searches for the property with the specified key in this property. Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.
|
|
Returns an vector of all the keys in this property. Returns an enumeration of all the keys in this property list, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.
|
|
Get node of Properties.
|
|
Save the properties list to the stream. Deprecated.
|
|
Sets a default value associated with key in the property list.
|
|
Sets a default value associated with key in the property list.
|
|
Sets a value associated with key in the property list. This method sets the "value" associated with "key" in the property list. If the property list has a value of "key", old value is returned.
|
|
Get number of Properties.
|
|
|
|
|
|
Stores property list to the output stream. Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method. The stream is written using the ISO 8859-1 character encoding. Properties from the defaults table of this Properties table (if any) are not written out by this method. If the comments argument is not null, then an ASCII # character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment. Next, a comment line is always written, consisting of an ASCII # character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer.
Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. Each character of the key and element strings is examined to see whether it should be rendered as an escape sequence. The ASCII characters \, tab, form feed, newline, and carriage return are written as \, , After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.
|
|
|