Properties class abstract

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.

Inheritance
Implementers

Constructors

Properties()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

clone() → Properties
Create a copy of this property set. @return A copy of this property set.
getCommandLineOptions() → StringSeq
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. @return The command line options for this property set.
getPropertiesForPrefix(String prefix) → PropertyDict
Get all properties whose keys begins with prefix. If prefix is an empty string, then all properties are returned. @param prefix The prefix to search for (empty string if none). @return The matching property set.
getProperty(String key) → String
Get a property by key. If the property is not set, an empty string is returned. @param key The property key. @return The property value. @see #setProperty
getPropertyAsInt(String key) → int
Get a property as an integer. If the property is not set, 0 is returned. @param key The property key. @return The property value interpreted as an integer. @see #setProperty
getPropertyAsIntWithDefault(String key, int value) → int
Get a property as an integer. If the property is not set, the given default value is returned. @param key The property key. @param value The default value to use if the property does not exist. @return The property value interpreted as an integer, or the default value. @see #setProperty
getPropertyAsList(String key) → StringSeq
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 , e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O'Reilly'. @param key The property key. @return The property value interpreted as a list of strings. @see #setProperty
getPropertyAsListWithDefault(String key, StringSeq value) → StringSeq
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 , e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O'Reilly'. @param key The property key. @param value The default value to use if the property is not set. @return The property value interpreted as list of strings, or the default value. @see #setProperty
getPropertyWithDefault(String key, String value) → String
Get a property by key. If the property is not set, the given default value is returned. @param key The property key. @param value The default value to use if the property does not exist. @return The property value or the default value. @see #setProperty
ice_id([Current? current]) → String
inherited
ice_ids([Current? current]) → List<String>
inherited
ice_isA(String s, [Current? current]) → bool
inherited
ice_ping([Current? current]) → void
inherited
iceD_ice_id(Incoming incoming, Current current) → bool
inherited
iceD_ice_ids(Incoming incoming, Current current) → bool
inherited
iceD_ice_isA(Incoming incoming, Current current) → bool
inherited
iceD_ice_ping(Incoming incoming, Current current) → bool
inherited
iceDispatch(Incoming incoming, Current current) → bool
inherited
load(String file) → void
Load properties from a file. @param file The property file.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseCommandLineOptions(String prefix, StringSeq options) → StringSeq
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. @param prefix The property prefix, or an empty string to convert all options starting with --. @param options The command-line options. @return The command-line options that do not start with the specified prefix, in their original order.
parseIceCommandLineOptions(StringSeq options) → StringSeq
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. @param options The command-line options. @return The command-line options that do not start with one of the listed prefixes, in their original order.
setProperty(String key, String value) → void
Set a property. To unset a property, set it to the empty string. @param key The property key. @param value The property value. @see #getProperty
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited