Ice 3.7 C++11 API Reference
|
A property set used to configure Ice and Ice applications. More...
#include <Ice/Ice.h>
Public Member Functions | |
virtual ::std::shared_ptr<::Ice::Properties > | clone () noexcept=0 |
Create a copy of this property set. More... | |
virtual ::Ice::StringSeq | getCommandLineOptions () noexcept=0 |
Get a sequence of command-line options that is equivalent to this property set. More... | |
virtual ::Ice::PropertyDict | getPropertiesForPrefix (const ::std::string &prefix) noexcept=0 |
Get all properties whose keys begins with prefix. More... | |
virtual ::std::string | getProperty (const ::std::string &key) noexcept=0 |
Get a property by key. More... | |
virtual int | getPropertyAsInt (const ::std::string &key) noexcept=0 |
Get a property as an integer. More... | |
virtual int | getPropertyAsIntWithDefault (const ::std::string &key, int value) noexcept=0 |
Get a property as an integer. More... | |
virtual ::Ice::StringSeq | getPropertyAsList (const ::std::string &key) noexcept=0 |
Get a property as a list of strings. More... | |
virtual ::Ice::StringSeq | getPropertyAsListWithDefault (const ::std::string &key, const StringSeq &value) noexcept=0 |
Get a property as a list of strings. More... | |
virtual ::std::string | getPropertyWithDefault (const ::std::string &key, const ::std::string &value) noexcept=0 |
Get a property by key. More... | |
virtual void | load (const ::std::string &file)=0 |
Load properties from a file. More... | |
virtual ::Ice::StringSeq | parseCommandLineOptions (const ::std::string &prefix, const StringSeq &options)=0 |
Convert a sequence of command-line options into properties. More... | |
virtual ::Ice::StringSeq | parseIceCommandLineOptions (const StringSeq &options)=0 |
Convert a sequence of command-line options into properties. More... | |
virtual void | setProperty (const ::std::string &key, const ::std::string &value)=0 |
Set a property. More... | |
virtual | ~Properties () |
A property set used to configure Ice and Ice applications.
Properties are key/value pairs, with both keys and values being strings. By convention, property keys should have the form application-name[.category[.sub-category]].name.
|
virtual |
|
pure virtualnoexcept |
Create a copy of this property set.
|
pure virtualnoexcept |
Get a sequence of command-line options that is equivalent to this property set.
Each element of the returned sequence is a command-line option of the form –key=value
.
|
pure virtualnoexcept |
Get all properties whose keys begins with prefix.
If prefix is an empty string, then all properties are returned.
prefix | The prefix to search for (empty string if none). |
|
pure virtualnoexcept |
Get a property by key.
If the property is not set, an empty string is returned.
key | The property key. |
|
pure virtualnoexcept |
Get a property as an integer.
If the property is not set, 0 is returned.
key | The property key. |
|
pure virtualnoexcept |
Get a property as an integer.
If the property is not set, the given default value is returned.
key | The property key. |
value | The default value to use if the property does not exist. |
|
pure virtualnoexcept |
Get a property as a list of strings.
The strings must be separated by whitespace or comma. If the property is not set, an empty list is returned. The strings in the list can contain whitespace and commas if they are enclosed in single or double quotes. If quotes are mismatched, an empty list is returned. Within single quotes or double quotes, you can escape the quote in question with a backslash, e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
key | The property key. |
|
pure virtualnoexcept |
Get a property as a list of strings.
The strings must be separated by whitespace or comma. If the property is not set, the default list is returned. The strings in the list can contain whitespace and commas if they are enclosed in single or double quotes. If quotes are mismatched, the default list is returned. Within single quotes or double quotes, you can escape the quote in question with a backslash, e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
key | The property key. |
value | The default value to use if the property is not set. |
|
pure virtualnoexcept |
Get a property by key.
If the property is not set, the given default value is returned.
key | The property key. |
value | The default value to use if the property does not exist. |
|
pure virtual |
Load properties from a file.
file | The property file. |
|
pure virtual |
Convert a sequence of command-line options into properties.
All options that begin with –prefix.
are converted into properties. If the prefix is empty, all options that begin with –
are converted to properties.
prefix | The property prefix, or an empty string to convert all options starting with – . |
options | The command-line options. |
|
pure virtual |
Convert a sequence of command-line options into properties.
All options that begin with one of the following prefixes are converted into properties: –Ice
, –IceBox
, –IceGrid
, –IcePatch2
, –IceSSL
, –IceStorm
, –Freeze
, and –Glacier2
.
options | The command-line options. |
|
pure virtual |
Set a property.
To unset a property, set it to the empty string.
key | The property key. |
value | The property value. |