org.protempa.backend

Class ConfigurationsProviderManager

java.lang.Object

org.protempa.backend.ConfigurationsProviderManager

public final class ConfigurationsProviderManager
extends Object

Class for getting PROTEMPA configurations. Uses Java's ServiceLoader to load a ConfigurationsProvider. By default, it configures ServiceLoader to use the current thread's context class loader. The ConfigurationsProvider is loaded lazily upon calls to getConfigurations() or getConfigurationsProvider(). Use setConfigurationsProviderClassLoader(java.lang.ClassLoader) to specify a different class loader. The ConfigurationsProvider in turn is used to get Configurations. A program can also explicitly set a configurations provider using the setConfigurationsProvider(org.protempa.backend.ConfigurationsProvider) method. This will override the use of ServiceLoader.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
ConfigurationsProviderManager()

Method Summary

Modifier and Type	Method and Description
static Configurations	getConfigurations() Convenience static method for getting configurations, like calling getConfigurationsProvider() followed by ConfigurationsProvider.getConfigurations().
static ConfigurationsProvider	getConfigurationsProvider() Gets the configurations provider found by service discovery or set with {@link #setConfigurationsProvider(org.protempa.backend.ConfigurationsProvider).
static ClassLoader	getConfigurationsProviderClassLoader()
static boolean	isConfigurationsProviderClassLoaderSpecified() Indicates whether setConfigurationsProviderClassLoader(java.lang.ClassLoader) has been called.
static void	setConfigurationsProvider(ConfigurationsProvider configurationsProvider) Sets the configurations provider, overriding any configurations provider that was found by service discovery.
static void	setConfigurationsProviderClassLoader(ClassLoader loader)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationsProviderManager

public ConfigurationsProviderManager()

Method Detail

setConfigurationsProviderClassLoader

public static void setConfigurationsProviderClassLoader(ClassLoader loader)

getConfigurationsProviderClassLoader

public static ClassLoader getConfigurationsProviderClassLoader()

isConfigurationsProviderClassLoaderSpecified

public static boolean isConfigurationsProviderClassLoaderSpecified()

Indicates whether setConfigurationsProviderClassLoader(java.lang.ClassLoader) has been called.

Returns:

whether setConfigurationsProviderClassLoader(java.lang.ClassLoader) has been called.

setConfigurationsProvider

public static void setConfigurationsProvider(ConfigurationsProvider configurationsProvider)

Sets the configurations provider, overriding any configurations provider that was found by service discovery.

Parameters:

configurationsProvider - a ConfigurationsProvider.

getConfigurationsProvider

public static ConfigurationsProvider getConfigurationsProvider()

Gets the configurations provider found by service discovery or set with {@link #setConfigurationsProvider(org.protempa.backend.ConfigurationsProvider).

Returns:

a ConfigurationsProvider.

getConfigurations

public static Configurations getConfigurations()

Convenience static method for getting configurations, like calling getConfigurationsProvider() followed by ConfigurationsProvider.getConfigurations().

Returns:

a Configurations instance.