Ice

Interface Properties

All Known Implementing Classes:

PropertiesI

public interface 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.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
Properties	_clone() Create a copy of this property set.
java.lang.String[]	getCommandLineOptions() Get a sequence of command-line options that is equivalent to this property set.
java.util.Map<java.lang.String,java.lang.String>	getPropertiesForPrefix(java.lang.String prefix) Get all properties whose keys begins with prefix.
java.lang.String	getProperty(java.lang.String key) Get a property by key.
int	getPropertyAsInt(java.lang.String key) Get a property as an integer.
int	getPropertyAsIntWithDefault(java.lang.String key, int value) Get a property as an integer.
java.lang.String[]	getPropertyAsList(java.lang.String key) Get a property as a list of strings.
java.lang.String[]	getPropertyAsListWithDefault(java.lang.String key, java.lang.String[] value) Get a property as a list of strings.
java.lang.String	getPropertyWithDefault(java.lang.String key, java.lang.String value) Get a property by key.
void	load(java.lang.String file) Load properties from a file.
java.lang.String[]	parseCommandLineOptions(java.lang.String prefix, java.lang.String[] options) Convert a sequence of command-line options into properties.
java.lang.String[]	parseIceCommandLineOptions(java.lang.String[] options) Convert a sequence of command-line options into properties.
void	setProperty(java.lang.String key, java.lang.String value) Set a property.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.String getProperty(java.lang.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(java.lang.String, java.lang.String)

getPropertyWithDefault

java.lang.String getPropertyWithDefault(java.lang.String key,
                                        java.lang.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(java.lang.String, java.lang.String)

getPropertyAsInt

int getPropertyAsInt(java.lang.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(java.lang.String, java.lang.String)

getPropertyAsIntWithDefault

int getPropertyAsIntWithDefault(java.lang.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(java.lang.String, java.lang.String)

getPropertyAsList

java.lang.String[] getPropertyAsList(java.lang.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 \, 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(java.lang.String, java.lang.String)

getPropertyAsListWithDefault

java.lang.String[] getPropertyAsListWithDefault(java.lang.String key,
                                                java.lang.String[] 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 \, 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(java.lang.String, java.lang.String)

getPropertiesForPrefix

java.util.Map<java.lang.String,java.lang.String> getPropertiesForPrefix(java.lang.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.

setProperty

void setProperty(java.lang.String key,
                 java.lang.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(java.lang.String)

getCommandLineOptions

java.lang.String[] 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.

parseCommandLineOptions

java.lang.String[] parseCommandLineOptions(java.lang.String prefix,
                                           java.lang.String[] 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

java.lang.String[] parseIceCommandLineOptions(java.lang.String[] 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.

load

void load(java.lang.String file)

Load properties from a file.

Parameters:

file - The property file.

_clone

Properties _clone()

Create a copy of this property set.

Returns:

A copy of this property set.