org.drombler.commons.client.startup.main

Class ApplicationConfiguration

java.lang.Object

org.drombler.commons.client.startup.main.ApplicationConfiguration

public class ApplicationConfiguration
extends Object

The application configuration packaged with the application. This configuration should usually not be configurable by the user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_DEFAULT_SINGLE_INSTANCE_PORT_PROPERTY_NAME The property name of the optional default single instance port property in the applicationConfig.properties file to indicate a single instance application.
static String	APPLICATION_PROPERTIES_FILE_PATH_ABSOLUTE The absolute path of the applicationConfig.properties file expected to be packaged within the application JAR.
static String	APPLICATION_PROPERTIES_FILE_PATH_RELATIVE The relative path of the applicationConfig.properties file expected to be packaged within the application JAR.

Constructor Summary

Constructors

Constructor and Description
ApplicationConfiguration() Creates a new instance of this class and loads the application configuration from the file '/applicationConfig.properties', if available.

Method Summary

Modifier and Type	Method and Description
int	getDefaultSingleInstancePort() Gets the configured default single instance port.
double	getDoubleProperty(String key, double defaultValue, String errorMessageFormat) Gets the double value associated with the specified key.
Integer	getIntegerProperty(String key, Integer defaultValue, String errorMessageFormat) Gets the integer value associated with the specified key.
double	getPositiveDoubleProperty(String key, double defaultValue, String errorMessageFormat) Gets the positive double value associated with the specified key.
String	getStringProperty(String key) Gets the String value associated with the specified key.
boolean	isSingleInstanceApplication() Flag if this is a single instance application.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_PROPERTIES_FILE_PATH_RELATIVE

public static final String APPLICATION_PROPERTIES_FILE_PATH_RELATIVE

The relative path of the applicationConfig.properties file expected to be packaged within the application JAR.

See Also:

Constant Field Values

APPLICATION_PROPERTIES_FILE_PATH_ABSOLUTE

public static final String APPLICATION_PROPERTIES_FILE_PATH_ABSOLUTE

The absolute path of the applicationConfig.properties file expected to be packaged within the application JAR.

See Also:

Constant Field Values

APPLICATION_DEFAULT_SINGLE_INSTANCE_PORT_PROPERTY_NAME

public static final String APPLICATION_DEFAULT_SINGLE_INSTANCE_PORT_PROPERTY_NAME

The property name of the optional default single instance port property in the applicationConfig.properties file to indicate a single instance application.

See Also:

Constant Field Values

Constructor Detail

ApplicationConfiguration

public ApplicationConfiguration()

Creates a new instance of this class and loads the application configuration from the file '/applicationConfig.properties', if available.

Method Detail

getDoubleProperty

public double getDoubleProperty(String key,
                                double defaultValue,
                                String errorMessageFormat)

Gets the double value associated with the specified key.

Parameters:

key - the key

defaultValue - the default value

errorMessageFormat - the error message format

Returns:

the double value associated with the specified key

getPositiveDoubleProperty

public double getPositiveDoubleProperty(String key,
                                        double defaultValue,
                                        String errorMessageFormat)

Gets the positive double value associated with the specified key.

Parameters:

key - the key

defaultValue - the default value returned if the value could not be loaded or was not positive

errorMessageFormat - the error message format

Returns:

the double value associated with the specified key

getIntegerProperty

public Integer getIntegerProperty(String key,
                                  Integer defaultValue,
                                  String errorMessageFormat)

Gets the integer value associated with the specified key.

Parameters:

key - the key

defaultValue - the default value

errorMessageFormat - the error message format

Returns:

the integer value associated with the specified key

getStringProperty

public String getStringProperty(String key)

Gets the String value associated with the specified key.

Parameters:

key - the key

Returns:

the String value associated with the specified key

isSingleInstanceApplication

public boolean isSingleInstanceApplication()

Flag if this is a single instance application.

Returns:

true, if this is a single instance application, else false

getDefaultSingleInstancePort

public int getDefaultSingleInstancePort()

Gets the configured default single instance port.

Returns:

the configured default single instance port