org.mdi.bootstrap

Class ConfigPropertiesHelper

java.lang.Object

org.mdi.bootstrap.ConfigPropertiesHelper

public class ConfigPropertiesHelper
extends java.lang.Object

This helper class allows to create named configuration properties.

Since:

1.4.16

See Also:

NamedConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigPropertiesHelper.ConfigSet The set of propeties for a configuration.
static class	ConfigPropertiesHelper.Property A configuration property.

Constructor Summary

Constructors

Constructor and Description
ConfigPropertiesHelper()

Method Summary

Modifier and Type	Method and Description
ConfigPropertiesHelper.ConfigSet	createConfiguration(java.lang.String configName) Creates a named configuration.
ConfigPropertiesHelper.ConfigSet	createDefaultConfiguration() Creates the default configuration.
ConfigPropertiesHelper.ConfigSet	getConfiguration(java.lang.String configName) Return the configuration of a specified name (or null if there is no configuration for this name).
java.util.Set<java.lang.String>	getConfigurationPropertiesNames(java.lang.String configName) Return the names of the configuration properties for a named configuration.
java.lang.Object	getConfigurationProperty(java.io.File dir, java.lang.String propertyName, java.lang.String configName) Return the property with a specified name for a named configuration.
java.lang.Class	getConfigurationPropertyType(java.lang.String propertyName, java.lang.String configName) Return the type of the property with a specified name for a named configuration.
ConfigPropertiesHelper.ConfigSet	getDefaultConfiguration() Return the default configuration (or null if there is no default configuration).
java.lang.Object	getDefaultConfigurationProperty(java.lang.String propertyName, java.lang.String configName) Return the default value for a property with a specified name for a named configuration.
boolean	hasConfiguration(java.lang.String configName) Return true if there is a configuration for a specified name.
boolean	hasConfigurationProperty(java.lang.String propertyName, java.lang.String configName) Return true if there is a property with a specified name for a named configuration.
boolean	hasDefaultConfiguration() Return true if there is a default configuration.
void	setConfigurationProperty(java.io.File dir, java.lang.String propertyName, java.lang.String configName, java.lang.Object property) Set the value of the property with a specified name for a named configuration.Return null by default.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigPropertiesHelper

public ConfigPropertiesHelper()

Method Detail

createDefaultConfiguration

public ConfigPropertiesHelper.ConfigSet createDefaultConfiguration()

Creates the default configuration. It will return the previously created default configuration if it was already created.

Returns:

the default configuration

createConfiguration

public ConfigPropertiesHelper.ConfigSet createConfiguration(java.lang.String configName)

Creates a named configuration. It will return the previously created configuration of this namme if it was already created.

Parameters:

configName - the configuration name

Returns:

the configuration

getConfigurationPropertiesNames

public java.util.Set<java.lang.String> getConfigurationPropertiesNames(java.lang.String configName)

Return the names of the configuration properties for a named configuration. Return null by default.

Parameters:

configName - the configuration name

Returns:

the names of the configuration properties

hasConfigurationProperty

public boolean hasConfigurationProperty(java.lang.String propertyName,
                                        java.lang.String configName)

Return true if there is a property with a specified name for a named configuration. Return false by default.

Parameters:

propertyName - the property name

configName - the configuration name

Returns:

true if there is a configuration properties for thr named configuration

getDefaultConfigurationProperty

public java.lang.Object getDefaultConfigurationProperty(java.lang.String propertyName,
                                                        java.lang.String configName)

Return the default value for a property with a specified name for a named configuration. Return null by default.

Parameters:

propertyName - the property name

configName - the configuration name

Returns:

the property default value

getConfigurationPropertyType

public java.lang.Class getConfigurationPropertyType(java.lang.String propertyName,
                                                    java.lang.String configName)

Return the type of the property with a specified name for a named configuration. Return null by default.

Parameters:

propertyName - the property name

configName - the configuration name

Returns:

the property Class

setConfigurationProperty

public void setConfigurationProperty(java.io.File dir,
                                     java.lang.String propertyName,
                                     java.lang.String configName,
                                     java.lang.Object property)

Set the value of the property with a specified name for a named configuration.Return null by default.

Parameters:

dir - the base directory

propertyName - the property name

configName - the configuration name

property - the property value

getConfigurationProperty

public java.lang.Object getConfigurationProperty(java.io.File dir,
                                                 java.lang.String propertyName,
                                                 java.lang.String configName)

Return the property with a specified name for a named configuration. Return null by default.

Parameters:

dir - the base directory

propertyName - the property name

configName - the configuration name

Returns:

the property

getDefaultConfiguration

public ConfigPropertiesHelper.ConfigSet getDefaultConfiguration()

Return the default configuration (or null if there is no default configuration).

Returns:

the default configuration

hasDefaultConfiguration

public boolean hasDefaultConfiguration()

Return true if there is a default configuration.

Returns:

true if there is a default configuration

hasConfiguration

public boolean hasConfiguration(java.lang.String configName)

Return true if there is a configuration for a specified name.

Parameters:

configName - the configuration name

Returns:

true if there is a configuration for thr specified name

getConfiguration

public ConfigPropertiesHelper.ConfigSet getConfiguration(java.lang.String configName)

Return the configuration of a specified name (or null if there is no configuration for this name).

Parameters:

configName - the configuration namme

Returns:

the configuration