Ice

Class PropertiesI

java.lang.Object

Ice.PropertiesI

All Implemented Interfaces:

Properties

public final class PropertiesI
extends java.lang.Object
implements Properties

Field Summary

Fields inherited from interface Ice.Properties

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.
java.util.List<java.lang.String>	getUnusedProperties()
void	load(java.lang.String file) Load properties from a file.
java.lang.String[]	parseCommandLineOptions(java.lang.String pfx, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key)

Description copied from interface: Properties

Get a property by key. If the property is not set, an empty string is returned.

Specified by:

getProperty in interface Properties

Parameters:

key - The property key.

Returns:

The property value.

See Also:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertyWithDefault

public java.lang.String getPropertyWithDefault(java.lang.String key,
                                               java.lang.String value)

Description copied from interface: Properties

Get a property by key. If the property is not set, the given default value is returned.

Specified by:

getPropertyWithDefault in interface Properties

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:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertyAsInt

public int getPropertyAsInt(java.lang.String key)

Description copied from interface: Properties

Get a property as an integer. If the property is not set, 0 is returned.

Specified by:

getPropertyAsInt in interface Properties

Parameters:

key - The property key.

Returns:

The property value interpreted as an integer.

See Also:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertyAsIntWithDefault

public int getPropertyAsIntWithDefault(java.lang.String key,
                                       int value)

Description copied from interface: Properties

Get a property as an integer. If the property is not set, the given default value is returned.

Specified by:

getPropertyAsIntWithDefault in interface Properties

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:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertyAsList

public java.lang.String[] getPropertyAsList(java.lang.String key)

Description copied from interface: Properties

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

Specified by:

getPropertyAsList in interface Properties

Parameters:

key - The property key.

Returns:

The property value interpreted as a list of strings.

See Also:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertyAsListWithDefault

public java.lang.String[] getPropertyAsListWithDefault(java.lang.String key,
                                                       java.lang.String[] value)

Description copied from interface: Properties

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

Specified by:

getPropertyAsListWithDefault in interface Properties

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:

Properties.setProperty(java.lang.String, java.lang.String)

getPropertiesForPrefix

public java.util.Map<java.lang.String,java.lang.String> getPropertiesForPrefix(java.lang.String prefix)

Description copied from interface: Properties

Get all properties whose keys begins with prefix. If prefix is an empty string, then all properties are returned.

Specified by:

getPropertiesForPrefix in interface Properties

Parameters:

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

Returns:

The matching property set.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Description copied from interface: Properties

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

Specified by:

setProperty in interface Properties

Parameters:

key - The property key.

value - The property value.

See Also:

Properties.getProperty(java.lang.String)

getCommandLineOptions

public java.lang.String[] getCommandLineOptions()

Description copied from interface: Properties

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.

Specified by:

getCommandLineOptions in interface Properties

Returns:

The command line options for this property set.

parseCommandLineOptions

public java.lang.String[] parseCommandLineOptions(java.lang.String pfx,
                                                  java.lang.String[] options)

Description copied from interface: Properties

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.

Specified by:

parseCommandLineOptions in interface Properties

Parameters:

pfx - 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

public java.lang.String[] parseIceCommandLineOptions(java.lang.String[] options)

Description copied from interface: Properties

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.

Specified by:

parseIceCommandLineOptions in interface Properties

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

public void load(java.lang.String file)

Description copied from interface: Properties

Load properties from a file.

Specified by:

load in interface Properties

Parameters:

file - The property file.

_clone

public Properties _clone()

Description copied from interface: Properties

Create a copy of this property set.

Specified by:

_clone in interface Properties

Returns:

A copy of this property set.

getUnusedProperties

public java.util.List<java.lang.String> getUnusedProperties()