com.zeroc.Ice.Properties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ice Show documentation
Ice is a comprehensive RPC framework that helps you build distributed applications with minimal effort using familiar object-oriented idioms
There is a newer version: 3.7.10
Show newest version
//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.9
//
// 
//
// Generated from file `Properties.ice'
//
// Warning: do not edit this file.
//
// 
//

package com.zeroc.Ice;

/**
 * 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.
 **/
public interface Properties
{
    /**
     * 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
     **/
    String getProperty(String key);

    /**
     * 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
     **/
    String getPropertyWithDefault(String key, String value);

    /**
     * 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
     **/
    int getPropertyAsInt(String key);

    /**
     * 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
     **/
    int getPropertyAsIntWithDefault(String key, int value);

    /**
     * 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
     **/
    String[] 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,
     * 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
     **/
    String[] getPropertyAsListWithDefault(String key, String[] value);

    /**
     * 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.
     **/
    java.util.Map getPropertiesForPrefix(String prefix);

    /**
     * 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
     **/
    void setProperty(String key, String value);

    /**
     * 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.
     **/
    String[] getCommandLineOptions();

    /**
     * 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.
     **/
    String[] parseCommandLineOptions(String prefix, 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.
     * @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.
     **/
    String[] parseIceCommandLineOptions(String[] options);

    /**
     * Load properties from a file.
     * @param file The property file.
     **/
    void load(String file);

    /**
     * Create a copy of this property set.
     * @return A copy of this property set.
     **/
    Properties _clone();
}