org.eclipse.stardust.engine.core.spi.preferences

Interface IStaticConfigurationProvider

public interface IStaticConfigurationProvider

An implementor of this interface can provide default preferences for one moduleId and multiple preferenceIds scoped by the moduleId.

To publish an implementor to the engine a file named by the interface's factory has to be created in the '/META-INF/services' folder of the jar.
In this case: org.eclipse.stardust.engine.core.spi.preferences.IStaticConfigurationProvider$Factory
This file needs to contain the qualified class name of the implementor of the factory interface.

This pattern follows the concept of the JDK6 ServiceLoader.

Author:

sauer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStaticConfigurationProvider.Factory The factory interface for IStaticConfigurationProvider

Method Summary

Methods

Modifier and Type	Method and Description
String	getModuleId()
Map	getPreferenceDefaults(String preferencesId)
List	getPreferenceIds()

Method Detail

getModuleId

String getModuleId()

Returns:

the moduleId which the static preferences are provided for

getPreferenceIds

List getPreferenceIds()

Returns:

the preferenceIds for which the static configuration provider provides preferences for.

getPreferenceDefaults

Map getPreferenceDefaults(String preferencesId)

Parameters:

preferencesId - the preferencesId to lookup default preferences for.

Returns:

a map containing default preferences for the specified preferencesId.