org.mdi.bootstrap

Interface NamedConfiguration

All Known Subinterfaces:

Configuration, Configuration2

All Known Implementing Classes:

AbstractConfiguration2

public interface NamedConfiguration

This interface defines the minimal common behaviour of named configurations.

Since:

1.4.16

See Also:

PluginsConfigurations, PluginManifestKeys.KEY_PLUGIN_CONFIG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONFIG

Method Summary

Modifier and Type	Method and Description
default void	getConfiguration(java.util.prefs.Preferences pref, java.io.File dir, java.lang.String confName) Called when the Preferences key-value entries must be updated with the configuration, for a configuration name.
default java.util.Set<java.lang.String>	getConfigurationPropertiesNames(java.lang.String confName) Return the names of the configuration properties for a named configuration.
default java.lang.Object	getConfigurationProperty(java.io.File dir, java.lang.String propertyName, java.lang.String confName) Return the property with a specified name for a named configuration.
default java.lang.Class	getConfigurationPropertyType(java.lang.String propertyName, java.lang.String confName) Return the type of the property with a specified name for a named configuration.
default java.lang.Object	getDefaultConfigurationProperty(java.lang.String propertyName, java.lang.String confName) Return the default value for a property with a specified name for a named configuration.
default boolean	hasConfigurationProperty(java.lang.String propertyName, java.lang.String confName) Return true if there is a property with a specified name for a named configuration.
default void	putConfiguration(java.util.prefs.Preferences pref, java.io.File dir, java.lang.String confName) Called when the configuration must be filled with key-value entries stored in a Preferences, for a configuration name.
default void	setConfigurationProperty(java.io.File dir, java.lang.String propertyName, java.lang.String confName, java.lang.Object property) Set the value of the property with a specified name for a named configuration.Return null by default.

Field Detail

DEFAULT_CONFIG

static final java.lang.String DEFAULT_CONFIG

See Also:

Constant Field Values

Method Detail

putConfiguration

default void putConfiguration(java.util.prefs.Preferences pref,
                              java.io.File dir,
                              java.lang.String confName)

Called when the configuration must be filled with key-value entries stored in a Preferences, for a configuration name. Do nothing by default.

Parameters:

pref - the Preferences

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

confName - the configuration name

getConfiguration

default void getConfiguration(java.util.prefs.Preferences pref,
                              java.io.File dir,
                              java.lang.String confName)

Called when the Preferences key-value entries must be updated with the configuration, for a configuration name. Do nothing by default.

Parameters:

pref - the Preferences

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

confName - the configuration name

getConfigurationPropertiesNames

default java.util.Set<java.lang.String> getConfigurationPropertiesNames(java.lang.String confName)

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

Parameters:

confName - the configuration name

Returns:

the names of the configuration properties

hasConfigurationProperty

default boolean hasConfigurationProperty(java.lang.String propertyName,
                                         java.lang.String confName)

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

Parameters:

propertyName - the property name

confName - the configuration name

Returns:

true if there is a configuration properties for thr named configuration

getConfigurationProperty

default java.lang.Object getConfigurationProperty(java.io.File dir,
                                                  java.lang.String propertyName,
                                                  java.lang.String confName)

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

Parameters:

dir - the base directory

propertyName - the property name

confName - the configuration name

Returns:

the property

getDefaultConfigurationProperty

default java.lang.Object getDefaultConfigurationProperty(java.lang.String propertyName,
                                                         java.lang.String confName)

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

Parameters:

propertyName - the property name

confName - the configuration name

Returns:

the property default value

getConfigurationPropertyType

default java.lang.Class getConfigurationPropertyType(java.lang.String propertyName,
                                                     java.lang.String confName)

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

Parameters:

propertyName - the property name

confName - the configuration name

Returns:

the property Class

setConfigurationProperty

default void setConfigurationProperty(java.io.File dir,
                                      java.lang.String propertyName,
                                      java.lang.String confName,
                                      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

confName - the configuration name

property - the property value