Ice::Properties Local Interface Reference

A property set used to configure Ice and Ice applications. More...

defined in <Ice/Properties.ice>

local interface Properties { ... }

Operations
Properties	clone ()
	Create a copy of this property set. More...
StringSeq	getCommandLineOptions ()
	Get a sequence of command-line options that is equivalent to this property set. More...
PropertyDict	getPropertiesForPrefix (string prefix)
	Get all properties whose keys begins with prefix. More...
string	getProperty (string key)
	Get a property by key. More...
int	getPropertyAsInt (string key)
	Get a property as an integer. More...
int	getPropertyAsIntWithDefault (string key, int \value)
	Get a property as an integer. More...
StringSeq	getPropertyAsList (string key)
	Get a property as a list of strings. More...
StringSeq	getPropertyAsListWithDefault (string key, StringSeq \value)
	Get a property as a list of strings. More...
string	getPropertyWithDefault (string key, string \value)
	Get a property by key. More...
void	load (string file)
	Load properties from a file. More...
StringSeq	parseCommandLineOptions (string prefix, StringSeq options)
	Convert a sequence of command-line options into properties. More...
StringSeq	parseIceCommandLineOptions (StringSeq options)
	Convert a sequence of command-line options into properties. More...
void	setProperty (string key, string \value)
	Set a property. More...

Detailed Description

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.

Operation Documentation

clone()

["cpp:noexcept","swift:noexcept","swift:nonnull"]

Properties clone

(

)

Create a copy of this property set.

Returns

A copy of this property set.

getCommandLineOptions()

["cpp:noexcept","swift:noexcept"]

StringSeq getCommandLineOptions

(

)

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.

Returns

The command line options for this property set.

getPropertiesForPrefix()

["cpp:noexcept","swift:noexcept"]

PropertyDict getPropertiesForPrefix

(

string

prefix

)

Get all properties whose keys begins with prefix.

If prefix is an empty string, then all properties are returned.

Parameters

prefix

The prefix to search for (empty string if none).

Returns

The matching property set.

getProperty()

["cpp:noexcept","swift:noexcept"]

string getProperty

(

string

key

)

Get a property by key.

If the property is not set, an empty string is returned.

Parameters

key	The property key.

Returns

The property value.

See also

setProperty

getPropertyAsInt()

["cpp:noexcept","swift:noexcept"]

int getPropertyAsInt

(

string

key

)

Get a property as an integer.

If the property is not set, 0 is returned.

Parameters

key	The property key.

Returns

The property value interpreted as an integer.

See also

setProperty

getPropertyAsIntWithDefault()

["cpp:noexcept","swift:noexcept"]

int getPropertyAsIntWithDefault	(	string	key,
		int \	value
	)

Get a property as an integer.

If the property is not set, the given default value is returned.

Parameters

key	The property key.
value	The default value to use if the property does not exist.

Returns

The property value interpreted as an integer, or the default value.

See also

setProperty

getPropertyAsList()

["cpp:noexcept","swift:noexcept"]

StringSeq getPropertyAsList

(

string

key

)

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'.

Parameters

key	The property key.

Returns

The property value interpreted as a list of strings.

See also

setProperty

getPropertyAsListWithDefault()

["cpp:noexcept","swift:noexcept"]

StringSeq getPropertyAsListWithDefault	(	string	key,
		StringSeq \	value
	)

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'.

Parameters

key	The property key.
value	The default value to use if the property is not set.

Returns

The property value interpreted as list of strings, or the default value.

See also

setProperty

getPropertyWithDefault()

["cpp:noexcept","swift:noexcept"]

string getPropertyWithDefault	(	string	key,
		string \	value
	)

Get a property by key.

If the property is not set, the given default value is returned.

Parameters

key	The property key.
value	The default value to use if the property does not exist.

Returns

The property value or the default value.

See also

setProperty

load()

void load

(

string

file

)

Load properties from a file.

Parameters

file	The property file.

parseCommandLineOptions()

StringSeq parseCommandLineOptions	(	string	prefix,
		StringSeq	options
	)

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.

Parameters

prefix	The property prefix, or an empty string to convert all options starting with –.
options	The command-line options.

Returns

The command-line options that do not start with the specified prefix, in their original order.

parseIceCommandLineOptions()

StringSeq parseIceCommandLineOptions

(

StringSeq

options

)

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.

Parameters

options

The command-line options.

Returns

The command-line options that do not start with one of the listed prefixes, in their original order.

setProperty()

["swift:noexcept"]

void setProperty	(	string	key,
		string \	value
	)

Set a property.

To unset a property, set it to the empty string.

Parameters

key	The property key.
value	The property value.

See also

getProperty

---

The documentation for this interface was generated from the following file:

• Ice/Properties.ice