org.daisy.streamline.api.config.ConfigurationsProvider Maven / Gradle / Ivy
The newest version!
package org.daisy.streamline.api.config;
import java.util.Map;
import java.util.Set;
/**
* Provides an interface for configurations providers. A configurations
* provider handles a set of configurations, each accessible via a configuration
* key.
* @author Joel Håkansson
*
*/
public interface ConfigurationsProvider {
/**
* Gets all configuration details available in the provider.
* @return returns a set of configuration details.
*/
public Set getConfigurationDetails();
/**
* Returns the properties associated with the specified by the identifier.
* @param key the configuration identifier
* @return returns the configuration properties
* @throws ConfigurationsProviderException if a configuration cannot be returned.
*/
public Map getConfiguration(String key) throws ConfigurationsProviderException;
/**
* Informs the implementation that it was discovered and instantiated using
* information collected from a file within the META-INF/services directory.
* In other words, it was created using SPI (service provider interfaces).
*
* This information, in turn, enables the implementation to use the same mechanism
* to set dependencies as needed.
*
* If this information is not given, an implementation
* should avoid using SPIs and instead use
* declarative services
* for dependency injection as specified by OSGi. Note that this also applies to
* several newInstance() methods in the Java API.
*
* The class that created an instance with SPI must call this method before
* putting it to use.
*/
public default void setCreatedWithSPI() {}
}